Як я можу стверджувати своє повідомлення про виключення з анотацією тесту JUnit?

Я написав кілька тестів JUnit з @Testанотацією. Якщо мій метод тестування кидає перевірений виняток, і якщо я хочу стверджувати повідомлення разом з винятком, чи є спосіб зробити це з @Testанотацією JUnit ? AFAIK, JUnit 4.7 не надає цю функцію, але чи надають її майбутні версії? Я знаю, що в .NET ви можете стверджувати повідомлення та клас виключення. Шукаєте подібну функцію в світі Java.

Це те, що я хочу:

@Test (expected = RuntimeException.class, message = "Employee ID is null")
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() {}

Ви можете використовувати @Ruleпримітку за допомогою ExpectedExceptionтакого:

@Rule
public ExpectedException expectedEx = ExpectedException.none();

@Test
public void shouldThrowRuntimeExceptionWhenEmployeeIDisNull() throws Exception {
    expectedEx.expect(RuntimeException.class);
    expectedEx.expectMessage("Employee ID is null");

    // do something that should throw the exception...
    System.out.println("=======Starting Exception process=======");
    throw new NullPointerException("Employee ID is null");
}

Зауважте, що приклад у ExpectedExceptionдокументах (на даний момент) помиляється - немає публічного конструктора, тому вам доведеться використовувати ExpectedException.none().

Мені подобається @Ruleвідповідь. Однак, якщо ви чомусь не хочете користуватися правилами. Є третій варіант.

@Test (expected = RuntimeException.class)
public void myTestMethod()
{
   try
   {
      //Run exception throwing operation here
   }
   catch(RuntimeException re)
   {
      String message = "Employee ID is null";
      assertEquals(message, re.getMessage());
      throw re;
    }
    fail("Employee Id Null exception did not throw!");
  }

Чи потрібно використовувати @Test(expected=SomeException.class)? Коли ми маємо стверджувати фактичне повідомлення про виняток, це ми робимо.

@Test
public void myTestMethod()
{
  try
  {
    final Integer employeeId = null;
    new Employee(employeeId);
    fail("Should have thrown SomeException but did not!");
  }
  catch( final SomeException e )
  {
    final String msg = "Employee ID is null";
    assertEquals(msg, e.getMessage());
  }
}

У JUnit 4.13 ви можете:

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertThrows;

...

@Test
void exceptionTesting() {
  IllegalArgumentException exception = assertThrows(
    IllegalArgumentException.class, 
    () -> { throw new IllegalArgumentException("a message"); }
  );

  assertEquals("a message", exception.getMessage());
}

Це також працює в JUnit 5, але з різним імпортом:

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

...

Насправді, найкраще використання - це спробувати. Чому? Тому що ви можете контролювати місце, де ви очікуєте винятку.

Розглянемо цей приклад:

@Test (expected = RuntimeException.class)
public void someTest() {
   // test preparation
   // actual test
}

Що робити, якщо одного дня код буде змінено, і підготовка до тестування буде запускати RuntimeException? У цьому випадку фактичний тест навіть не перевіряється, і навіть якщо він не кидає жодного винятку, тест пройде.

Ось чому набагато краще використовувати try / catch, ніж покладатися на анотацію.

Райсторм мав хорошу відповідь. Я також не великий фанат Правил. Я роблю щось подібне, за винятком того, що створюю наступний клас корисності для полегшення читабельності та зручності використання, що в першу чергу є одним із великих плюсів анотацій.

Додайте цей клас корисності:

import org.junit.Assert;

public abstract class ExpectedRuntimeExceptionAsserter {

    private String expectedExceptionMessage;

    public ExpectedRuntimeExceptionAsserter(String expectedExceptionMessage) {
        this.expectedExceptionMessage = expectedExceptionMessage;
    }

    public final void run(){
        try{
            expectException();
            Assert.fail(String.format("Expected a RuntimeException '%s'", expectedExceptionMessage));
        } catch (RuntimeException e){
            Assert.assertEquals("RuntimeException caught, but unexpected message", expectedExceptionMessage, e.getMessage());
        }
    }

    protected abstract void expectException();

}

Тоді для мого одиничного тестування мені потрібно лише цей код:

@Test
public void verifyAnonymousUserCantAccessPrivilegedResourceTest(){
    new ExpectedRuntimeExceptionAsserter("anonymous user can't access privileged resource"){
        @Override
        protected void expectException() {
            throw new RuntimeException("anonymous user can't access privileged resource");
        }
    }.run(); //passes test; expected exception is caught, and this @Test returns normally as "Passed"
}

Якщо використовується @Rule, набір винятків застосовується до всіх методів тестування в класі Test.

Мені ніколи не подобався спосіб стверджувати винятки з Джунітом. Якщо я використовую "очікуване" в анотації, здається, з моєї точки зору, ми порушуємо "заданий, коли, тоді" шаблон, оскільки "тоді" розміщено у верхній частині тестового визначення.

Крім того, якщо ми використовуємо "@Rule", нам доведеться мати справу з стільки кодовим кодом. Отже, якщо ви можете встановити нові бібліотеки для своїх тестів, я б запропонував ознайомитися з AssertJ (ця бібліотека тепер поставляється разом з SpringBoot)

Потім тест, який не порушує принципи "задано / коли / тоді", і робиться за допомогою AssertJ для перевірки:

1 - Виняток - це те, що ми очікуємо. 2 - Це також очікуване повідомлення

Вигляне так:

 @Test
void should_throwIllegalUse_when_idNotGiven() {

    //when
    final Throwable raisedException = catchThrowable(() -> getUserDAO.byId(null));

    //then
    assertThat(raisedException).isInstanceOf(IllegalArgumentException.class)
            .hasMessageContaining("Id to fetch is mandatory");
}

Мені подобається відповідь user64141, але я виявив, що вона може бути більш узагальненою. Ось мій взяття:

public abstract class ExpectedThrowableAsserter implements Runnable {

    private final Class<? extends Throwable> throwableClass;
    private final String expectedExceptionMessage;

    protected ExpectedThrowableAsserter(Class<? extends Throwable> throwableClass, String expectedExceptionMessage) {
        this.throwableClass = throwableClass;
        this.expectedExceptionMessage = expectedExceptionMessage;
    }

    public final void run() {
        try {
            expectException();
        } catch (Throwable e) {
            assertTrue(String.format("Caught unexpected %s", e.getClass().getSimpleName()), throwableClass.isInstance(e));
            assertEquals(String.format("%s caught, but unexpected message", throwableClass.getSimpleName()), expectedExceptionMessage, e.getMessage());
            return;
        }
        fail(String.format("Expected %s, but no exception was thrown.", throwableClass.getSimpleName()));
    }

    protected abstract void expectException();

}

Зауважте, що залишення оператора "fail" у блоці спробу спричиняє вилучення відповідного винятку твердження; використання повернення в заяві про вилов це запобігає.

Імпортуйте бібліотеку винятків для вилову та скористайтеся цим. Це набагато чистіше, ніж ExpectedExceptionправило чи а try-catch.

Прикладіть форму своїх документів:

import static com.googlecode.catchexception.CatchException.*;
import static com.googlecode.catchexception.apis.CatchExceptionHamcrestMatchers.*;

// given: an empty list
List myList = new ArrayList();

// when: we try to get the first element of the list
catchException(myList).get(1);

// then: we expect an IndexOutOfBoundsException with message "Index: 1, Size: 0"
assertThat(caughtException(),
  allOf(
    instanceOf(IndexOutOfBoundsException.class),
    hasMessage("Index: 1, Size: 0"),
    hasNoCause()
  )
);

@Test (expectedExceptions = ValidationException.class, expectedExceptionsMessageRegExp = "This is not allowed")
public void testInvalidValidation() throws Exception{
     //test code
}