Подтвердить что ты не робот

В Java как я могу проверить исключение с JUnit?

При написании модульных тестов для Java API могут быть ситуации, когда вы хотите выполнить более детальную проверку исключения. То есть больше, чем предлагается аннотацией @test, предлагаемой JUnit.

Например, рассмотрим класс, который должен поймать исключение из какого-либо другого интерфейса, обернуть это исключение и выбросить обернутое исключение. Вы можете проверить:

  • Точный вызов метода, который выдает завернутое исключение.
  • Для исключения оболочки есть исходное исключение в качестве причины.
  • Сообщение об исключении обертки.

Главное, что вы хотите быть дополнительной проверкой исключения в unit test (не дискуссия о том, следует ли проверять такие вещи, как сообщение об исключении).

Какой хороший подход для этого?

4b9b3361

Ответ 1

В JUnit 4 это можно сделать с помощью правила ExpectedException.

Вот пример из javadocs:

// These tests all pass.
public static class HasExpectedException {
    @Rule
    public ExpectedException thrown = ExpectedException.none();

    @Test
    public void throwsNothing() {
        // no exception expected, none thrown: passes.
    }

    @Test
    public void throwsNullPointerException() {
        thrown.expect(NullPointerException.class);
        throw new NullPointerException();
    }

    @Test
    public void throwsNullPointerExceptionWithMessage() {
        thrown.expect(NullPointerException.class);
        thrown.expectMessage("happened?");
        thrown.expectMessage(startsWith("What"));
        throw new NullPointerException("What happened?");
    }
}

Ответ 2

Как указано в вашем ответе, это хороший подход. В дополнение к этому:

Вы можете обернуть функцию expectException в новую аннотацию, называемую ExpectedException.
Аннотированный метод будет выглядеть так:

@Test
@ExpectedException(class=WrapperException.class, message="Exception Message", causeException)
public void testAnExceptionWrappingFunction() {
  //whatever you test
}

Этот способ был бы более читабельным, но он точно такой же.

Другая причина: мне нравятся аннотации:)

Ответ 3

Глядя на предлагаемые ответы, вы действительно можете почувствовать боль от отсутствия закрытия на Java. ИМХО, наиболее читаемое решение - это хорошая старая попытка поймать.

@Test
public void test() {
    ...
    ...
    try {
        ...
        fail("No exception caught :(");
    }
    catch (RuntimeException ex) {
        assertEquals(Whatever.class, ex.getCause().getClass());
        assertEquals("Message", ex.getMessage());
    }
}

Ответ 4

Для JUNIT 3.x

public void test(){
   boolean thrown = false;
   try{
      mightThrowEx();
   } catch ( Surprise expected ){
      thrown = true;
      assertEquals( "message", expected.getMessage());
   }
  assertTrue(thrown );
}

Ответ 5

До этого сообщения я выполнил мою проверку исключения, выполнив следующее:

try {
    myObject.doThings();
    fail("Should've thrown SomeException!");
} catch (SomeException e) {
    assertEquals("something", e.getSomething());
}

Я несколько минут думал о проблеме и придумал следующее (Java5, JUnit 3.x):

// Functor interface for exception assertion.
public interface AssertionContainer<T extends Throwable> {
    void invoke() throws T;
    void validate(T throwable);
    Class<T> getType();
}

// Actual assertion method.
public <T extends Throwable> void assertThrowsException(AssertionContainer<T> functor) {
    try {
        functor.invoke();
        fail("Should've thrown "+functor.getType()+"!");
    } catch (Throwable exc) {
        assertSame("Thrown exception was of the wrong type! Expected "+functor.getClass()+", actual "+exc.getType(),
                   exc.getClass(), functor.getType());
        functor.validate((T) exc);
    }
}

// Example implementation for servlet I used to actually test this. It was an inner class, actually.
AssertionContainer<ServletException> functor = new AssertionContainer<ServletException>() {
    public void invoke() throws ServletException {
        servlet.getRequiredParameter(request, "some_param");
    }

    public void validate(ServletException e) {
        assertEquals("Parameter \"some_param\" wasn't found!", e.getMessage());
    }

    public Class<ServletException> getType() {
        return ServletException.class;
    }
}

// And this is how it used.
assertThrowsException(functor);

Глядя на эти два, я не могу решить, какой из них мне больше нравится. Я предполагаю, что это одна из тех проблем, когда достижение цели (в моем случае, метод утверждения с параметром-функтором) не стоит в конечном счете, так как намного проще сделать эти 6+ кода, чтобы утвердить попытку..catch блок.

И снова, может быть, мой 10-минутный результат решения проблем в пятницу вечером - это не самый разумный способ сделать это.

Ответ 6

@akuhn:

Даже без закрытия мы можем получить более читаемое решение (используя catch-exception):

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

public void test() {
    ...
    ...
    catchException(nastyBoy).doNastyStuff();
    assertTrue(caughtException() instanceof WhateverException);
    assertEquals("Message", caughtException().getMessage());
}

Ответ 7

Следующий вспомогательный метод (адаптированный из этого сообщения в блоге) делает трюк:

/**
 * Run a test body expecting an exception of the
 * given class and with the given message.
 *
 * @param test              To be executed and is expected to throw the exception.
 * @param expectedException The type of the expected exception.
 * @param expectedMessage   If not null, should be the message of the expected exception.
 * @param expectedCause     If not null, should be the same as the cause of the received exception.
 */
public static void expectException(
        Runnable test,
        Class<? extends Throwable> expectedException,
        String expectedMessage,
        Throwable expectedCause) {
    try {
        test.run();
    }
    catch (Exception ex) {
        assertSame(expectedException, ex.getClass());
        if (expectedMessage != null) {
            assertEquals(expectedMessage, ex.getMessage());
        }

        if (expectedCause != null) {
            assertSame(expectedCause, ex.getCause());
        }

        return;
    }

    fail("Didn't find expected exception of type " + expectedException.getName());
}

Затем тестовый код может вызвать это следующим образом:

TestHelper.expectException(
        new Runnable() {
            public void run() {
                classInstanceBeingTested.methodThatThrows();
            }
        },
        WrapperException.class,
        "Exception Message",
        causeException
);

Ответ 8

Я сделал что-то очень простое

testBla(){
    try {
        someFailingMethod()
        fail(); //method provided by junit
    } catch(Exception e) {
          //do nothing
    }
}

Ответ 9

Я сделал помощника, аналогичного другим опубликованным:

public class ExpectExceptionsExecutor {

    private ExpectExceptionsExecutor() {
    }

    public static  void execute(ExpectExceptionsTemplate e) {
        Class<? extends Throwable> aClass = e.getExpectedException();

        try {
            Method method = ExpectExceptionsTemplate.class.getMethod("doInttemplate");
            method.invoke(e);
        } catch (NoSuchMethodException e1) {


            throw new RuntimeException();
        } catch (InvocationTargetException e1) {


            Throwable throwable = e1.getTargetException();
            if (!aClass.isAssignableFrom(throwable.getClass())) {
                //  assert false
                fail("Exception isn't the one expected");
            } else {
                assertTrue("Exception captured ", true);
                return;
            }
            ;


        } catch (IllegalAccessException e1) {
            throw new RuntimeException();
        }

        fail("No exception has been thrown");
    }


}

И шаблон, который должен реализовать клиент

public interface ExpectExceptionsTemplate<T extends Throwable> {


    /**
     * Specify the type of exception that doInttemplate is expected to throw
     * @return
     */
    Class<T> getExpectedException();


    /**
     * Execute risky code inside this method
     * TODO specify expected exception using an annotation
     */
    public void doInttemplate();

}

И код клиента будет примерно таким:

@Test
    public void myTest() throws Exception {
        ExpectExceptionsExecutor.execute(new ExpectExceptionsTemplate() {
            @Override
            public Class getExpectedException() {
                return IllegalArgumentException.class;
            }

            @Override
            public void doInttemplate() {
                riskyMethod.doSomething(null);
            }
        });
     }

Он выглядит действительно многословным, но если вы используете IDE с хорошим автозаполнением, вам нужно будет только написать тип исключения и фактический тестируемый код. (остальное будет сделано IDE: D)

Ответ 10

Для JUnit 5 это намного проще:

    @Test
    void testAppleIsSweetAndRed() throws Exception {

        IllegalArgumentException ex = assertThrows(
                IllegalArgumentException.class,
                () -> testClass.appleIsSweetAndRed("orange", "red", "sweet"));

        assertEquals("this is the exception message", ex.getMessage());
        assertEquals(NullPointerException.class, ex.getCause().getClass());
    }

Вернув сам объект исключения, assertThrows() позволяет вам проверять каждый аспект относительно ваших исключенных исключений.