From 54618f0a9f4ca21db2d699b4e0a18e6357e644c0 Mon Sep 17 00:00:00 2001 From: Tsygankov Pavel Date: Sat, 14 Nov 2026 10:09:10 +0300 Subject: [PATCH] validum 0.4.1 --- .github/workflows/ci.yml | 2 +- CHANGELOG.md | 17 ++++++++++++++++- docs/COMPATIBILITY.md | 2 +- docs/DEMO-SCENARIO.md | 6 +++--- docs/INTEGRATIONS.md | 2 +- docs/REST.md | 9 +++++---- gradle.properties | 2 +- .../api/controller/GenerationController.java | 12 ++++++++++++ .../validum/api/controller/BatchFieldsTest.java | 14 ++++++++++++++ 9 files changed, 54 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 6890eda..a6bff7c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -124,7 +124,7 @@ jobs: run: | ./gradlew :validum-api:bootJar --no-daemon java -jar validum-cli/build/libs/validum.jar fetch-bik -o data/ED807.xml - python3 tools/rest-smoke.py --jar "$(ls validum-api/build/libs/*.jar | head -1)" --root "$(pwd)" --keep-log + python3 tools/rest-smoke.py --jar "$(ls validum-api/build/libs/*.jar | grep -v -- -plain | head -1)" --root "$(pwd)" --keep-log build-jdk17: name: Build & Test (JDK 17) diff --git a/CHANGELOG.md b/CHANGELOG.md index 326074f..9da2e16 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,18 @@ Ничего не запланировано — состав следующей версии определится после 0.4.0. +## [0.4.1] — 2026-11-14 + +Патч: REST-сервис больше не принимает `?fields=` молча для JSON-форматов. + +### Fixed +- `POST /api/v1/generate/{individual,ip,organization}/batch?fields=…&format=json|json-array` + теперь отвечает `400 {"error":"invalid_argument"}` с подсказкой про `format=csv`; раньше параметр + игнорировался и клиент получал полный набор, не зная об этом. +- `tools/rest-smoke.py` читает БИК из вложенного `bank.bik` (раньше `validate/account` падал с пустым + БИК), смоук REST в CI берёт boot-jar, а не `-plain.jar`, `tools/consumer-smoke.py` вызывает + `BikSources.resolve(String)`. + ## [0.4.0] — 2026-11-14 Планируется: `--format xlsx` без зависимостей, разложение `core/export` по слоям, @@ -101,6 +113,8 @@ - `--fields` для `generate individual|ip|organization`: оставить только нужные колонки (пресет `short` — «человеческий» набор). В спецификации — `"fields"`, в REST — `?fields=` для CSV-батчей; неизвестная колонка даёт ошибку со списком доступных, а не пустой столбец. + `?fields=` вместе с `format=json|json-array` отбивается `400 invalid_argument` — для JSON набор + уже структурирован, и молча игнорировать параметр нельзя. ### Changed - **README разложен по `docs/*`:** лендинг на 71 строку (что это, 30 секунд, таблица разделов, @@ -301,7 +315,8 @@ Требования: JDK 21. Справочник `data/ED807.xml` обязателен — `validum fetch-bik -o data/ED807.xml`. Порядок выпуска версии — `docs/RELEASING.md`. -[Unreleased]: https://github.com/Validum-Tech/validum/compare/v0.4.0...HEAD +[Unreleased]: https://github.com/Validum-Tech/validum/compare/v0.4.1...HEAD +[0.4.1]: https://github.com/Validum-Tech/validum/compare/v0.4.0...v0.4.1 [0.4.0]: https://github.com/Validum-Tech/validum/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/Validum-Tech/validum/compare/v0.2.0...v0.3.0 [0.2.0]: https://github.com/Validum-Tech/validum/releases/tag/v0.2.0 diff --git a/docs/COMPATIBILITY.md b/docs/COMPATIBILITY.md index 0667948..b9e4fc1 100644 --- a/docs/COMPATIBILITY.md +++ b/docs/COMPATIBILITY.md @@ -71,7 +71,7 @@ REST: 400 — невалидный ввод, 503 `bik_source_missing` — не ## 4. Ломающие изменения До 1.0 допускаются в минорных версиях, но с двумя условиями: строка в CHANGELOG и обновлённый -этот файл. Планируются в 0.4.0: +этот файл. Планируются в 0.5.0: - перемещение пакетов `ru.validum.core.export` → `format` / `mapping` / `cbr` (импорты у потребителей `validum-core` придётся поправить); diff --git a/docs/DEMO-SCENARIO.md b/docs/DEMO-SCENARIO.md index 5a785ab..9657ca1 100644 --- a/docs/DEMO-SCENARIO.md +++ b/docs/DEMO-SCENARIO.md @@ -336,7 +336,7 @@ Import-Csv out\ip-okved.csv | Select-Object okved, okvedName, registrationCity, ```kotlin // build.gradle.kts -implementation("io.github.validum-tech:validum-core:0.4.0") +implementation("io.github.validum-tech:validum-core:0.4.1") ``` - Увидишь: jar скачивается из Maven Central, `repositories { mavenCentral() }` уже есть. - Скажи: «`validum-core` — обычная библиотека из Central: без Spring, без сети, ноль @@ -531,7 +531,7 @@ curl -s -w "`nHTTP %{http_code}`n" -X POST http://localhost:8080/api/v1/generate ## 4.1 Подключение ```kotlin -testImplementation("io.github.validum-tech:validum-allure:0.4.0") +testImplementation("io.github.validum-tech:validum-allure:0.4.1") testRuntimeOnly("io.qameta.allure:allure-junit5:2.35.3") // ваша версия Allure ``` - Скажи: «Расширение **не навязывает** версию Allure — зависит от `allure-java-commons` @@ -579,7 +579,7 @@ validum-demo/ │ ├── run.ps1 ← сценарий из Видео 1 целиком │ └── specs/*.json ← наборы как код ├── core/ ← Видео 2 -│ ├── build.gradle.kts ← validum-core:0.4.0 +│ ├── build.gradle.kts ← validum-core:0.4.1 │ └── src/test/java/DemoCoreTest.java ├── api/ ← Видео 3 │ ├── docker-compose.yml ← REST-сервис одной командой diff --git a/docs/INTEGRATIONS.md b/docs/INTEGRATIONS.md index 1f33807..5202462 100644 --- a/docs/INTEGRATIONS.md +++ b/docs/INTEGRATIONS.md @@ -5,7 +5,7 @@ Java-библиотека и JUnit 5 + Allure: как подключить valid ## 🎭 Allure Extension (P3.2) ```kotlin -testImplementation("io.github.validum-tech:validum-allure:0.4.0") +testImplementation("io.github.validum-tech:validum-allure:0.4.1") ``` ```java diff --git a/docs/REST.md b/docs/REST.md index 329e1c6..fc508b1 100644 --- a/docs/REST.md +++ b/docs/REST.md @@ -9,7 +9,7 @@ Spring Boot-сервис: batch-эндпоинты, fill, validate, scenarios, e | **REST API** | Автотесты (JUnit + REST Assured), Swagger UI | `docker compose up` → `POST /api/v1/generate/...` | | **CLI** | Скрипты сетапа, CI-пайплайны, «100 профилей в CSV» | `java -jar validum.jar generate individual --count 100 --format csv -o profiles.csv` | | **Allure Extension** | JUnit 5: attach профиля в Allure-отчёт | `@ValidumSeed(42)` / `@ValidumGenerate(...)` | -| **Java-библиотека** | Свой генератор поверх core | `io.github.validum-tech:validum-core:0.4.0` (Maven Central) | +| **Java-библиотека** | Свой генератор поверх core | `io.github.validum-tech:validum-core:0.4.1` (Maven Central) | --- @@ -188,7 +188,7 @@ java -jar validum.jar coverage --file clients.csv ``` ``` -# validum 0.4.0 coverage · file=clients.csv · rows=100 +# validum 0.4.1 coverage · file=clients.csv · rows=100 поле заполнено различных невалидных -------------------------------------------------- @@ -230,8 +230,9 @@ java -jar validum.jar generate individual --seed 42 -n 3 --format csv --fields s Название колонки проверяется: опечатка не уходит в пустой столбец, а падает с ошибкой «Неизвестные колонки: passport. В наборе есть, например: personId, fullName, …». Порядок колонок при явном списке — как у профиля, поэтому файл остаётся стабильным между прогонами. В спецификации -то же поле называется `"fields"`, а в REST — параметр запроса `?fields=short` (пока для CSV-форматов -батчей). +то же поле называется `"fields"`, а в REST — параметр запроса `?fields=short` — только для `format=csv` +и `csv-semicolon`: для `json`/`json-array` набор уже структурирован, и такой запрос честно отбивается +`400 {"error":"invalid_argument"}` вместо тихого игнорирования. ### 🧭 Найти человека в наборе diff --git a/gradle.properties b/gradle.properties index b4ecc49..b7b46c0 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,6 @@ # Версия проекта — единственное место, где она меняется. # Скрипт релиза сверяет её с тегом и с package.json витрины. -version=0.4.0 +version=0.4.1 # JVM org.gradle.jvmargs=-Xmx2g -XX:MaxMetaspaceSize=512m -Dfile.encoding=UTF-8 diff --git a/validum-api/src/main/java/ru/validum/api/controller/GenerationController.java b/validum-api/src/main/java/ru/validum/api/controller/GenerationController.java index 93ee305..d615a53 100644 --- a/validum-api/src/main/java/ru/validum/api/controller/GenerationController.java +++ b/validum-api/src/main/java/ru/validum/api/controller/GenerationController.java @@ -64,6 +64,15 @@ public ResponseEntity generateOrganization( // ── Батчи ───────────────────────────────────────────────────────────────── + /** `?fields=` осмыслен только для CSV: JSON отдаёт структурированный DTO, а не плоские колонки. */ + private static void requireCsvForFields(String format, String fields) { + if (fields != null && !format.toLowerCase().startsWith("csv")) { + throw new IllegalArgumentException( + "Параметр fields применяется только к format=csv|csv-semicolon; " + + "для json/json-array набор уже структурирован"); + } + } + @PostMapping(value = "/individual/batch") @Operation( summary = "Сгенерировать пакет профилей физлиц", @@ -75,6 +84,7 @@ public ResponseEntity generateIndividualBatch( @Parameter(description = "Оставить только эти колонки CSV (через запятую) или пресет short") @RequestParam(required = false) String fields) { + requireCsvForFields(format, fields); return switch (format.toLowerCase()) { case "json-array" -> okWithMeta(service.generateIndividualBatch(request).profiles(), request.seed()); @@ -107,6 +117,7 @@ public ResponseEntity generateIpBatch( @Parameter(description = "Оставить только эти колонки CSV (через запятую) или пресет short") @RequestParam(required = false) String fields) { + requireCsvForFields(format, fields); return switch (format.toLowerCase()) { case "json-array" -> okWithMeta(service.generateIpBatch(request).profiles(), request.seed()); @@ -139,6 +150,7 @@ public ResponseEntity generateOrganizationBatch( @Parameter(description = "Оставить только эти колонки CSV (через запятую) или пресет short") @RequestParam(required = false) String fields) { + requireCsvForFields(format, fields); return switch (format.toLowerCase()) { case "json-array" -> okWithMeta(service.generateOrganizationBatch(request).profiles(), request.seed()); diff --git a/validum-api/src/test/java/ru/validum/api/controller/BatchFieldsTest.java b/validum-api/src/test/java/ru/validum/api/controller/BatchFieldsTest.java index 55c0ab2..55afba2 100644 --- a/validum-api/src/test/java/ru/validum/api/controller/BatchFieldsTest.java +++ b/validum-api/src/test/java/ru/validum/api/controller/BatchFieldsTest.java @@ -45,6 +45,20 @@ void withoutFields() throws Exception { assertThat(header).contains("secretWord").contains("terrorist").contains("asOf"); } + @Test + @DisplayName("?fields= с json отбивается 400 — молча игнорировать нельзя") + void fieldsRequireCsv() throws Exception { + MvcResult result = mockMvc + .perform( + post("/api/v1/generate/individual/batch?format=json-array&fields=short") + .contentType(MediaType.APPLICATION_JSON) + .content("{\"count\":2,\"seed\":42}")) + .andExpect(status().isBadRequest()) + .andReturn(); + String body = result.getResponse().getContentAsString(StandardCharsets.UTF_8); + assertThat(body).contains("invalid_argument").contains("format=csv"); + } + /** REST-CSV отдаётся с BOM (как и файловый) — для сверки заголовка его снимаем. */ private static String headerOf(String body) { return body.lines().findFirst().orElse("").replace("\uFEFF", "");