Оператор переключения покрытия кода JUnit с веткой по умолчанию
У меня есть метод util для обработки текста. Способ обработки определяется enum Mode. При написании модульного теста для покрытия этого метода мне пришлось добавить фиктивный элемент enum, чтобы включить default часть оператора switch в тестирование. Часть по умолчанию — это моя проверка на случай, если enum расширен новым элементом, и этот новый элемент не добавлен в оператор switch, что означает, что обработка для этого нового элемента будет невозможна. Если я удалю фиктивный элемент и попробую использовать null, то получу NPE, а Java даже не введет оператор switch — это нормальное поведение, когда вы используете null для оператора switch.
Вопрос: есть ли способ избежать добавления фиктивного enum элемента, но при этом покрыть default часть оператора switch в модульном тесте?
Дополнение для ясности: Java 17, JUnit Jupiter 5, Инструмент покрытия кода Eclipse.
Код
abstract class LineBreaker {
public enum Mode {
LAST_SPACES,
LAST_CHARS,
DUMMY
}
public static String process(
final String text,
final LineBreaker.Mode mode,
final int amount
) {
switch (mode) {
case LAST_SPACES : {
// blah blah create `processingResult`
return processingResult;
}
case LAST_CHARS : {
// blah blah create `processingResult`
return processingResult;
}
default :
throw new IllegalStateException(
"Processor for " +
LineBreaker.class.getSimpleName() + "." +
LineBreaker.Mode.class.getSimpleName() + "." +
mode.name() +
" not implemented"
);
}
}
}
Модульный тест
@Test
void testLineBreakerException() {
assertThrows(
IllegalStateException.class,
() -> LineBreaker.process( "Dog", LineBreaker.Mode.DUMMY, 10 ),
"Expected " + IllegalStateException.class.getSimpleName()
);
}
Модульный тест без дополнительного фиктивного элемента перечисления
Покрытие кода без дополнительного фиктивного элемента перечисления
Юнит-тест с дополнительным фиктивным элементом перечисления
Покрытие кода без дополнительного фиктивного элемента перечисления
Ответы 2
Вам не нужно создавать или расширять существующее enum Mode. Вам просто нужно высмеять это перечисление с помощью Mockito.
Для этого вы можете использовать Mockito версии 5 или более поздней версии, которая поддерживает Mockito-inline в качестве средства создания макетов по умолчанию. Это позволит легко поддерживать издевательский статический метод.
Группа testImplementation: «org.mockito», имя: «mockito-core», версия: «5.11.0»
Стратегия состоит в том, чтобы создать макет перечисления UNSUPPORTED. Используйте Mockito.mockStatic, чтобы имитировать статический метод values() перечисления и возвращайте существующие значения плюс фиктивное перечисление UNSUPPORTED.
Тогда это псевдо-перечисление UNSUPPORTED вызовет путь по умолчанию для вашего оператора switch-case, что позволит вам легко выполнить утверждение.
Фрагмент кода
import org.junit.jupiter.api.Test;
import org.mockito.MockedStatic;
import org.mockito.Mockito;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.mockito.Mockito.doReturn;
public class SOEnumQuestionTest {
public enum Mode {
LAST_SPACES,
LAST_CHARS
}
public static String process(final Mode mode) {
switch (mode) {
case LAST_SPACES : {
return "processing last spaces";
}
case LAST_CHARS : {
return "processing last chars";
}
default :
throw new IllegalStateException("Processor not implemented");
}
}
@Test
public void testProcessWithDefaultSwitchCase() {
try (MockedStatic<Mode> dummyModeMockedStatic = Mockito.mockStatic(Mode.class)) {
final Mode UNSUPPORTED = Mockito.mock(Mode.class);
// We want to give the mocked enum in the last position of the enum values list
// E.g: Enum has 2 values -> our mock UNSUPPORTED enum index is 2
doReturn(2).when(UNSUPPORTED).ordinal();
dummyModeMockedStatic.when(Mode::values)
.thenReturn(new Mode[]{
Mode.LAST_SPACES,
Mode.LAST_CHARS,
UNSUPPORTED});
Throwable expectedException = assertThrows(IllegalStateException.class, () -> SOEnumQuestionTest.process(UNSUPPORTED));
assertEquals("Processor not implemented", expectedException.getMessage());
}
}
}
При необходимости вы также можете имитировать возврат метода name() из мока UNSUPPORTED, как и функцию ordinal().
Нет, используйте JDK. Java 17 позволяет переключаться с помощью перечислений и проверяет, все ли случаи учтены. В противном случае код не будет компилироваться, поэтому вам даже не понадобится тест (см. другой ответ на этот вопрос).
Поскольку вы используете Java 17 и ваши ветки возвращают значение, вместо этого вы можете использовать выражение переключения , которое должно быть исчерпывающим (поэтому компилятор проверит, что вы охватываете все случаи).
public static String process(
final String text,
final LineBreaker.Mode mode,
final int amount
) {
String result = switch (mode) {
case LAST_SPACES -> "some processing result";
case LAST_CHARS -> "another result";
};
return result;
}
Таким образом, вам не понадобится ветка по умолчанию или тест.
Идея default состоит в том, чтобы принудительно реализовать все элементы перечисления и покрыть недостающие реализации исключениями. Например, если добавляется еще один элемент (назовем его FIRST_SPACES), то я хочу, чтобы он умер, выдав исключение, а не получил неожиданный результат. Я не уверен на 100%, что это лучшая архитектура, но пока у меня есть хороший опыт работы с ней. Это довольно простое перечисление, состоящее всего из двух элементов, но в некоторых других случаях, когда присутствует больше элементов, я думаю, что хорошо иметь такую «защиту».
Оно работает! Мне пришлось удалить часть сообщения об исключении, потому что
name()методUNSUPPORTEDвызвалArrayOutOfBoundsException, но я могу с этим жить - все равно в 1000 раз лучше, чем вводить бесполезный фиктивныйenumэлемент только для того, чтобы соответствовать какому-то инструменту покрытия кода.