JaCoCo: гейт покрытия 90% строк + сводка/артефакты репортов в CI
Корневой pom: jacoco-maven-plugin 0.8.15 (prepare-agent, report+check на
verify, report раньше check — отчёт готов даже при провале гейта), surefire
argLine через @{argLine}. pr.yml/main.yml job java: Coverage summary в
step summary + артефакт jacoco-html (оба шага if: always()).
Тесты ради гейта (23 класса / 218 @Test): app ConversionService/
ApiExceptionHandler/ConversionTimeout +1 в ConvertController; core
DrawMlColor/DrawMlText + инкременты ChartSpec/PresetGeometry.
Покрытие: core 91,0%, app 92,9% строк.
This commit is contained in:
@@ -0,0 +1,57 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.http.HttpStatus;
|
||||
import org.springframework.web.multipart.MaxUploadSizeExceededException;
|
||||
|
||||
import java.time.Duration;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertFalse;
|
||||
|
||||
/**
|
||||
* Прямые юниты {@link ApiExceptionHandler} для кодов, не выжимаемых из
|
||||
* MockMvc детерминированно: 503 (очередь полна — гонка по времени), 413
|
||||
* (нужна загрузка за 100 МБ), catch-all 500 (все штатные исключения
|
||||
* замаплены). Контракт — код + дословный текст {@code {"error": …}}.
|
||||
*/
|
||||
class ApiExceptionHandlerTest {
|
||||
|
||||
private final ApiExceptionHandler handler = new ApiExceptionHandler();
|
||||
|
||||
/** Занятая очередь — 503 с подсказкой «повторите», текст — контракт. */
|
||||
@Test
|
||||
void rejected_returns503WithRetryHint() {
|
||||
var response = handler.rejected(new ConversionRejectedException());
|
||||
assertEquals(HttpStatus.SERVICE_UNAVAILABLE, response.getStatusCode());
|
||||
assertEquals("Сервис конвертации занят — повторите позже",
|
||||
response.getBody().error());
|
||||
}
|
||||
|
||||
/** Превышение wordpdf.convert-timeout — 504 с длительностью лимита. */
|
||||
@Test
|
||||
void timeout_returns504WithLimitSeconds() {
|
||||
var response = handler.timeout(new ConversionTimeoutException(Duration.ofSeconds(120)));
|
||||
assertEquals(HttpStatus.GATEWAY_TIMEOUT, response.getStatusCode());
|
||||
assertEquals("Конвертация превысила 120 с — документ слишком сложный",
|
||||
response.getBody().error());
|
||||
}
|
||||
|
||||
/** Контейнерный потолок multipart — 413 со своим текстом (не 400 ядра). */
|
||||
@Test
|
||||
void tooLarge_returns413ContainerLimit() {
|
||||
var response = handler.tooLarge(new MaxUploadSizeExceededException(100L * 1024 * 1024));
|
||||
assertEquals(HttpStatus.PAYLOAD_TOO_LARGE, response.getStatusCode());
|
||||
assertEquals("Файл больше 100 МБ", response.getBody().error());
|
||||
}
|
||||
|
||||
/** Прочее исключение — 500 с общим текстом; подробность причины — только в лог. */
|
||||
@Test
|
||||
void unexpected_returns500WithoutDetails() {
|
||||
var response = handler.unexpected(new IllegalStateException("секретная подробность"));
|
||||
assertEquals(HttpStatus.INTERNAL_SERVER_ERROR, response.getStatusCode());
|
||||
assertEquals("Внутренняя ошибка конвертации", response.getBody().error());
|
||||
assertFalse(response.getBody().error().contains("секретная"),
|
||||
"подробность исключения утекла в ответ");
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,144 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.junit.jupiter.api.Test;
|
||||
import ru.pjandro.wordpdf.ConvertOptions;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.lang.reflect.Field;
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.time.Duration;
|
||||
import java.util.ArrayList;
|
||||
import java.util.List;
|
||||
import java.util.concurrent.CountDownLatch;
|
||||
import java.util.concurrent.Future;
|
||||
import java.util.concurrent.ThreadPoolExecutor;
|
||||
import java.util.concurrent.TimeUnit;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertEquals;
|
||||
import static org.junit.jupiter.api.Assertions.assertSame;
|
||||
import static org.junit.jupiter.api.Assertions.assertThrows;
|
||||
import static org.junit.jupiter.api.Assertions.assertTrue;
|
||||
|
||||
/**
|
||||
* Юниты {@link ConversionService} вне Spring и HTTP: ветки отказa очереди
|
||||
* ({@link ConversionRejectedException}), прерывания ожидающего потока,
|
||||
* фолбэка санитизации имени. Сквозные успех/400/500 — в
|
||||
* {@code ConvertControllerTest}, таймаут 504 — в {@code ConversionTimeoutTest}.
|
||||
*/
|
||||
class ConversionServiceTest {
|
||||
|
||||
/** Инспекция приватного executor'а: детерминированная сатурация очереди. */
|
||||
private static ThreadPoolExecutor workersOf(ConversionService svc) throws Exception {
|
||||
Field f = ConversionService.class.getDeclaredField("workers");
|
||||
f.setAccessible(true);
|
||||
return (ThreadPoolExecutor) f.get(svc);
|
||||
}
|
||||
|
||||
/** Байты фикстуры из classpath (test-jar core: samples/…). */
|
||||
private static byte[] bytes(String resource) throws IOException {
|
||||
try (InputStream in = ConversionServiceTest.class.getResourceAsStream(resource)) {
|
||||
assertTrue(in != null, "Нет ресурса: " + resource);
|
||||
return in.readAllBytes();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Очередь забита (1 воркер занят + QUEUE_CAPACITY в ожидании) — новый
|
||||
* запрос отвергается сразу, не становясь 17-м в очереди: 503-контракт
|
||||
* {@code RejectedExecutionException → ConversionRejectedException}.
|
||||
*/
|
||||
@Test
|
||||
void saturatedQueue_rejectsImmediately() throws Exception {
|
||||
ConversionService svc = new ConversionService(Duration.ofMinutes(2));
|
||||
ThreadPoolExecutor workers = workersOf(svc);
|
||||
CountDownLatch block = new CountDownLatch(1);
|
||||
List<Future<?>> fillers = new ArrayList<>();
|
||||
try {
|
||||
// заглушки-блокировки вместо реальных конвертаций: воркер занят,
|
||||
// очередь полна, ни одной лишней конвертации в JVM
|
||||
for (int i = 0; i <= ConversionService.QUEUE_CAPACITY; i++) {
|
||||
fillers.add(workers.submit(() -> {
|
||||
block.await();
|
||||
return null;
|
||||
}));
|
||||
}
|
||||
long deadline = System.nanoTime() + 5_000_000_000L;
|
||||
while ((workers.getActiveCount() < 1
|
||||
|| workers.getQueue().size() < ConversionService.QUEUE_CAPACITY)
|
||||
&& System.nanoTime() < deadline) {
|
||||
Thread.sleep(5);
|
||||
}
|
||||
assertEquals(1, workers.getActiveCount(), "воркер не занят");
|
||||
assertEquals(ConversionService.QUEUE_CAPACITY, workers.getQueue().size(),
|
||||
"очередь не полна");
|
||||
|
||||
byte[] sample = bytes("/samples/ru-plain.docx");
|
||||
ConversionRejectedException e = assertThrows(ConversionRejectedException.class,
|
||||
() -> svc.convert(sample, "queue.docx", ConvertOptions.defaults()));
|
||||
assertEquals("Сервис конвертации занят — повторите позже", e.getMessage());
|
||||
} finally {
|
||||
block.countDown();
|
||||
for (Future<?> f : fillers) {
|
||||
f.get(10, TimeUnit.SECONDS);
|
||||
}
|
||||
svc.shutdown();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Поток ожидания прерван — {@code future.get} бросает
|
||||
* {@code InterruptedException}: флаг прерывания восстанавливается, задача
|
||||
* отменяется, ответ — тот же 503-контракт занятости.
|
||||
*/
|
||||
@Test
|
||||
void interruptedWaiter_rejectsAndRestoresFlag() throws Exception {
|
||||
ConversionService svc = new ConversionService(Duration.ofMinutes(2));
|
||||
byte[] sample = bytes("/samples/ru-plain.docx");
|
||||
try {
|
||||
Thread.currentThread().interrupt();
|
||||
ConversionRejectedException e = assertThrows(ConversionRejectedException.class,
|
||||
() -> svc.convert(sample, "ru-plain.docx", ConvertOptions.defaults()));
|
||||
assertEquals("Сервис конвертации занят — повторите позже", e.getMessage());
|
||||
assertTrue(Thread.currentThread().isInterrupted(),
|
||||
"флаг прерывания обязан быть восстановлен");
|
||||
} finally {
|
||||
Thread.interrupted(); // не травим subsequent-тесты surefire-потока
|
||||
}
|
||||
// барьер: отменённая задача ещё домучивает рендер на воркере, а
|
||||
// глобальный реестр шрифтов ядра не потокобезопасен — ждём освобождения
|
||||
// воркера через успешную сериализованную конвертацию
|
||||
byte[] pdf = svc.convert(sample, "barrier.docx", ConvertOptions.defaults());
|
||||
assertEquals("%PDF", new String(pdf, 0, 4, StandardCharsets.US_ASCII));
|
||||
svc.shutdown();
|
||||
}
|
||||
|
||||
/** Пустое после очистки имя (и {@code null}) — фолбэк {@code document}. */
|
||||
@Test
|
||||
void safeBaseName_blankAfterSanitize_fallsBackToDocument() {
|
||||
assertEquals("document", ConversionService.safeBaseName(null));
|
||||
assertEquals("document", ConversionService.safeBaseName(" "));
|
||||
assertEquals("document", ConversionService.safeBaseName("###.docx"));
|
||||
assertEquals("document", ConversionService.safeBaseName("!!!"));
|
||||
}
|
||||
|
||||
/** Каталог (оба разделителя) и суффикс .docx вырезаются, кириллица живёт. */
|
||||
@Test
|
||||
void safeBaseName_stripsDirectoryAndSuffix() {
|
||||
assertEquals("evil", ConversionService.safeBaseName("a/../../evil.docx"));
|
||||
assertEquals("evil", ConversionService.safeBaseName("C:\\tmp\\evil.docx"));
|
||||
assertEquals("отчёт", ConversionService.safeBaseName("отчёт.DOCX"));
|
||||
}
|
||||
|
||||
/**
|
||||
* Оборачиваемый отказ воркера: single-arg конструктор даёт единый
|
||||
* пользовательский текст 500 без подробностей причины (они — в логе).
|
||||
*/
|
||||
@Test
|
||||
void failedException_singleArg_genericMessageWithCause() {
|
||||
Throwable cause = new IllegalStateException("подробность воркера");
|
||||
ConversionFailedException e = new ConversionFailedException(cause);
|
||||
assertEquals("Внутренняя ошибка конвертации", e.getMessage());
|
||||
assertSame(cause, e.getCause());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,91 @@
|
||||
package ru.pjandro.wordpdf.app;
|
||||
|
||||
import org.junit.jupiter.api.AfterEach;
|
||||
import org.junit.jupiter.api.Test;
|
||||
import org.springframework.beans.factory.annotation.Autowired;
|
||||
import org.springframework.boot.webmvc.test.autoconfigure.AutoConfigureMockMvc;
|
||||
import org.springframework.boot.test.context.SpringBootTest;
|
||||
import org.springframework.http.MediaType;
|
||||
import org.springframework.mock.web.MockMultipartFile;
|
||||
import org.springframework.test.context.TestPropertySource;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.InputStream;
|
||||
import java.lang.reflect.Field;
|
||||
import java.util.concurrent.ThreadPoolExecutor;
|
||||
|
||||
import static org.junit.jupiter.api.Assertions.assertNotNull;
|
||||
import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.multipart;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
|
||||
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
|
||||
|
||||
/**
|
||||
* Таймаут конвертации сквозь HTTP: отдельный контекст с
|
||||
* {@code wordpdf.convert-timeout=1ms} — конвертация заведомо дольше
|
||||
* (docx4j + FOP — сотни миллисекунд), значит ответ обязан быть 504 с
|
||||
* текстом {@link ConversionTimeoutException}, а не зависание и не 500.
|
||||
* Отдельный класс: {@code @TestPropertySource} даёт отдельный контекст,
|
||||
* а 1 мс в общем контексте сломала бы все успех-тесты.
|
||||
*/
|
||||
@SpringBootTest
|
||||
@AutoConfigureMockMvc
|
||||
@TestPropertySource(properties = "wordpdf.convert-timeout=1ms")
|
||||
class ConversionTimeoutTest {
|
||||
|
||||
private static final MediaType DOCX =
|
||||
MediaType.parseMediaType("application/vnd.openxmlformats-officedocument.wordprocessingml.document");
|
||||
|
||||
@Autowired
|
||||
private MockMvc mockMvc;
|
||||
|
||||
@Autowired
|
||||
private ConversionService conversionService;
|
||||
|
||||
private static byte[] bytes(String resource) throws IOException {
|
||||
try (InputStream in = ConversionTimeoutTest.class.getResourceAsStream(resource)) {
|
||||
assertNotNull(in, "Нет ресурса: " + resource);
|
||||
return in.readAllBytes();
|
||||
}
|
||||
}
|
||||
|
||||
private static MockMultipartFile docx(String filename, byte[] content) {
|
||||
return new MockMultipartFile("file", filename, DOCX.toString(), content);
|
||||
}
|
||||
|
||||
@Test
|
||||
void conversionOverrunsTimeout_returns504() throws Exception {
|
||||
byte[] sample = bytes("/samples/ru-plain.docx");
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("ru-plain.docx", sample)))
|
||||
.andExpect(status().isGatewayTimeout())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("превысила")));
|
||||
// воркер ещё домучивает отменённый рендер — второй запрос ждёт в
|
||||
// очереди заведомо дольше 1 мс и тоже получает 504, а не 503:
|
||||
// очередь при этом не переполнена
|
||||
mockMvc.perform(multipart("/api/v1/convert")
|
||||
.file(docx("ru-plain.docx", sample)))
|
||||
.andExpect(status().isGatewayTimeout())
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("превысила")));
|
||||
}
|
||||
|
||||
/**
|
||||
* Отменённая по таймауту задача продолжает рендерить на воркере
|
||||
* (осознанный компромисс {@link ConversionService}) и мутирует глобальный
|
||||
* реестр шрифтов ядра — дожидаться освобождения executor'я обязательно,
|
||||
* иначе фоновый рендер гонит гонку с другими тест-классами JVM.
|
||||
*/
|
||||
@AfterEach
|
||||
void drainWorker() throws Exception {
|
||||
Field f = ConversionService.class.getDeclaredField("workers");
|
||||
f.setAccessible(true);
|
||||
ThreadPoolExecutor workers = (ThreadPoolExecutor) f.get(conversionService);
|
||||
long deadline = System.nanoTime() + 60_000_000_000L;
|
||||
while ((workers.getActiveCount() > 0 || !workers.getQueue().isEmpty())
|
||||
&& System.nanoTime() < deadline) {
|
||||
Thread.sleep(20);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -15,6 +15,7 @@ import org.springframework.http.MediaType;
|
||||
import org.springframework.mock.web.MockMultipartFile;
|
||||
import org.springframework.test.web.servlet.MockMvc;
|
||||
import org.springframework.test.web.servlet.MvcResult;
|
||||
import ru.pjandro.wordpdf.ValidationException;
|
||||
|
||||
import java.io.ByteArrayOutputStream;
|
||||
import java.io.IOException;
|
||||
@@ -400,4 +401,25 @@ class ConvertControllerTest {
|
||||
.andExpect(jsonPath("$.error",
|
||||
org.hamcrest.Matchers.containsString("Не найдено")));
|
||||
}
|
||||
|
||||
/**
|
||||
* Отказ чтения партиты контейнером ({@code IOException} из
|
||||
* {@code getBytes}) — {@link ValidationException} (400-смысл: вход не
|
||||
* прочитан), а не 500 от catch-all.
|
||||
*/
|
||||
@Test
|
||||
void unreadableUpload_rejected() {
|
||||
MockMultipartFile broken = new MockMultipartFile(
|
||||
"file", "x.docx", DOCX.toString(), "junk".getBytes(StandardCharsets.UTF_8)) {
|
||||
@Override
|
||||
public byte[] getBytes() throws IOException {
|
||||
throw new IOException("поток загрузки оборвался");
|
||||
}
|
||||
};
|
||||
ConvertController controller =
|
||||
new ConvertController(new ConversionService(Duration.ofSeconds(5)), 5L, 100);
|
||||
ValidationException e = assertThrows(ValidationException.class,
|
||||
() -> controller.convert(broken, null, null, null));
|
||||
assertTrue(e.getMessage().contains("Не удалось прочитать"), e.getMessage());
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user