Твърдения в JUnit 4 и JUnit 5

Програмиране

1. Въведение

В тази статия ще разгледаме подробно твърденията, налични в JUnit.

След мигрирането от JUnit 4 към JUnit 5 и Ръководство за статии от JUnit 5, сега навлизаме в подробности за различните твърдения, налични в JUnit 4 и JUnit 5.

Също така ще подчертаем подобренията, направени в твърденията с JUnit 5.

2. Твърдения

Твърденията са полезни методи за подпомагане на отстояване на условия в тестове ; тези методи са достъпни чрез класа Assert в JUnit 4 и този на Assertions в JUnit 5.

За да се увеличи четливостта на теста и на самите твърдения, винаги се препоръчва да импортирате статично съответния клас. По този начин можем да се позовем директно на самия метод на твърдение, без представящия клас като префикс.

Нека започнем да изследваме твърденията, налични с JUnit 4.

3. Твърдения в JUnit 4

В тази версия на библиотеката са налични твърдения за всички примитивни типове, обекти и масиви (или на примитиви, или на обекти).

Редът на параметрите, в рамките на твърдението, е очакваната стойност, последвана от действителната стойност; по избор първият параметър може да бъде низово съобщение, което представлява изхода на съобщението на оценяваното условие.

Има само едно малко по-различно в начина, по който се определят твърденията assertThat , но ще го разгледаме по-късно.

Нека започнем с assertEquals .

3.1. assertEquals

Твърдението assertEquals потвърждава, че очакваните и действителните стойности са равни:

@Test public void whenAssertingEquality_thenEqual() { String expected = "Baeldung"; String actual = "Baeldung"; assertEquals(expected, actual); }

Също така е възможно да посочите съобщение, което да се показва, когато твърдението не успее:

assertEquals("failure - strings are not equal", expected, actual);

3.2. assertArrayEquals

Ако искаме да твърдим, че два масива са равни, можем да използваме assertArrayEquals:

@Test public void whenAssertingArraysEquality_thenEqual() { char[] expected = {'J','u','n','i','t'}; char[] actual = "Junit".toCharArray(); assertArrayEquals(expected, actual); }

Ако и двата масива са нула , твърдението ще ги счита за равни:

@Test public void givenNullArrays_whenAssertingArraysEquality_thenEqual() { int[] expected = null; int[] actual = null; assertArrayEquals(expected, actual); }

3.3. assertNotNull и assertNull

Когато искаме да тестваме дали даден обект е нулев, можем да използваме твърдението assertNull :

@Test public void whenAssertingNull_thenTrue() { Object car = null; assertNull("The car should be null", car); }

По обратния начин, ако искаме да твърдим, че даден обект не трябва да е нула, можем да използваме твърдението assertNotNull.

3.4. assertNotSame и assertSame

С assertNotSame е възможно да се провери дали две променливи не се отнасят към един и същ обект:

@Test public void whenAssertingNotSameObject_thenDifferent() { Object cat = new Object(); Object dog = new Object(); assertNotSame(cat, dog); }

В противен случай, когато искаме да проверим дали две променливи се отнасят до един и същ обект, можем да използваме твърдение assertSame .

3.5. assertTrue и assertFalse

В случай, че искаме да проверим дали определено условие е вярно или невярно , можем съответно да използваме твърдението assertTrue или assertFalse :

@Test public void whenAssertingConditions_thenVerified() { assertTrue("5 is greater then 4", 5 > 4); assertFalse("5 is not greater then 6", 5 > 6); }

3.6. провалят се

The се провалят твърдение не успее тест хвърляне на AssertionFailedError . Може да се използва, за да се провери дали действително изключение е хвърлено или когато искаме да направим тест, неуспешен по време на неговото разработване.

Нека да видим как можем да го използваме в първия сценарий:

@Test public void whenCheckingExceptionMessage_thenEqual() { try { methodThatShouldThrowException(); fail("Exception not thrown"); } catch (UnsupportedOperationException e) { assertEquals("Operation Not Supported", e.getMessage()); } }

3.7. твърдя това

В assertThat твърдение е единственият в JUnit 4, която има обратен ред на параметрите в сравнение с другите твърдения.

В този случай твърдението има незадължително съобщение за грешка, действителната стойност и обект Matcher .

Нека да видим как можем да използваме това твърдение, за да проверим дали масивът съдържа определени стойности:

@Test public void testAssertThatHasItems() { assertThat( Arrays.asList("Java", "Kotlin", "Scala"), hasItems("Java", "Kotlin")); }

Допълнителна информация за мощното използване на твърдението assertThat с обект Matcher е достъпна при Тестване с Hamcrest.

4. JUnit 5 Твърдения

JUnit 5 запази много от методите за твърдение на JUnit 4, като същевременно добави няколко нови, които се възползват от поддръжката на Java 8.

Също така в тази версия на библиотеката са налични твърдения за всички примитивни типове, обекти и масиви (или на примитиви, или на обекти).

The order of the parameters of the assertions changed, moving the output message parameter as the last parameter. Thanks to the support of Java 8, the output message can be a Supplier, allowing lazy evaluation of it.

Let's start reviewing the assertions available also in JUnit 4.

4.1. assertArrayEquals

The assertArrayEquals assertion verifies that the expected and the actual arrays are equals:

@Test public void whenAssertingArraysEquality_thenEqual() { char[] expected = { 'J', 'u', 'p', 'i', 't', 'e', 'r' }; char[] actual = "Jupiter".toCharArray(); assertArrayEquals(expected, actual, "Arrays should be equal"); }

If the arrays aren't equal, the message “Arrays should be equal” will be displayed as output.

4.2. assertEquals

In case we want to assert that two floats are equals, we can use the simple assertEquals assertion:

@Test public void whenAssertingEquality_thenEqual() { float square = 2 * 2; float rectangle = 2 * 2; assertEquals(square, rectangle); }

However, if we want to assert that the actual value differs by a predefined delta from the expected value, we can still use the assertEquals but we have to pass the delta value as the third parameter:

@Test public void whenAssertingEqualityWithDelta_thenEqual() { float square = 2 * 2; float rectangle = 3 * 2; float delta = 2; assertEquals(square, rectangle, delta); }

4.3. assertTrue and assertFalse

With the assertTrue assertion, it's possible to verify the supplied conditions are true:

@Test public void whenAssertingConditions_thenVerified() { assertTrue(5 > 4, "5 is greater the 4"); assertTrue(null == null, "null is equal to null"); }

Thanks to the support of the lambda expression, it's possible to supply a BooleanSupplier to the assertion instead of a boolean condition.

Let's see how we can assert the correctness of a BooleanSupplier using the assertFalse assertion:

@Test public void givenBooleanSupplier_whenAssertingCondition_thenVerified() { BooleanSupplier condition = () -> 5 > 6; assertFalse(condition, "5 is not greater then 6"); }

4.4. assertNull and assertNotNull

When we want to assert that an object is not null we can use the assertNotNull assertion:

@Test public void whenAssertingNotNull_thenTrue() { Object dog = new Object(); assertNotNull(dog, () -> "The dog should not be null"); }

In the opposite way, we can use the assertNull assertion to check if the actual is null:

@Test public void whenAssertingNull_thenTrue() { Object cat = null; assertNull(cat, () -> "The cat should be null"); }

In both cases, the failure message will be retrieved in a lazy way since it's a Supplier.

4.5. assertSame and assertNotSame

When we want to assert that the expected and the actual refer to the same Object, we must use the assertSame assertion:

@Test public void whenAssertingSameObject_thenSuccessfull() { String language = "Java"; Optional optional = Optional.of(language); assertSame(language, optional.get()); }

In the opposite way, we can use the assertNotSame one.

4.6. fail

The fail assertion fails a test with the provided failure message as well as the underlying cause. This can be useful to mark a test when it's development it's not completed:

@Test public void whenFailingATest_thenFailed() { // Test not completed fail("FAIL - test not completed"); }

4.7. assertAll

One of the new assertion introduced in JUnit 5 is assertAll.

This assertion allows the creation of grouped assertions, where all the assertions are executed and their failures are reported together. In details, this assertion accepts a heading, that will be included in the message string for the MultipleFailureError, and a Stream of Executable.

Let's define a grouped assertion:

@Test public void givenMultipleAssertion_whenAssertingAll_thenOK() { assertAll( "heading", () -> assertEquals(4, 2 * 2, "4 is 2 times 2"), () -> assertEquals("java", "JAVA".toLowerCase()), () -> assertEquals(null, null, "null is equal to null") ); }

The execution of a grouped assertion is interrupted only when one of the executables throws a blacklisted exception (OutOfMemoryError for example).

4.8. assertIterableEquals

The assertIterableEquals asserts that the expected and the actual iterables are deeply equal.

In order to be equal, both iterable must return equal elements in the same order and it isn't required that the two iterables are of the same type in order to be equal.

With this consideration, let's see how we can assert that two lists of different types (LinkedList and ArrayList for example) are equal:

@Test public void givenTwoLists_whenAssertingIterables_thenEquals() { Iterable al = new ArrayList(asList("Java", "Junit", "Test")); Iterable ll = new LinkedList(asList("Java", "Junit", "Test")); assertIterableEquals(al, ll); }

In the same way of the assertArrayEquals, if both iterables are null, they are considered equal.

4.9. assertLinesMatch

The assertLinesMatch asserts that the expected list of String matches the actual list.

This method differs from the assertEquals and assertIterableEquals since, for each pair of expected and actual lines, it performs this algorithm:

  1. check if the expected line is equal to the actual one. If yes it continues with the next pair
  2. treat the expected line as a regular expression and performs a check with the String.matches() method. If yes it continues with the next pair
  3. check if the expected line is a fast-forward marker. If yes apply fast-forward and repeat the algorithm from the step 1

Let's see how we can use this assertion to assert that two lists of String have matching lines:

@Test public void whenAssertingEqualityListOfStrings_thenEqual() { List expected = asList("Java", "\\d+", "JUnit"); List actual = asList("Java", "11", "JUnit"); assertLinesMatch(expected, actual); }

4.10. assertNotEquals

Complementary to the assertEquals, the assertNotEquals assertion asserts that the expected and the actual values aren't equal:

@Test public void whenAssertingEquality_thenNotEqual() { Integer value = 5; // result of an algorithm assertNotEquals(0, value, "The result cannot be 0"); }

If both are null, the assertion fails.

4.11. assertThrows

In order to increase simplicity and readability, the new assertThrows assertion allows us a clear and a simple way to assert if an executable throws the specified exception type.

Let's see how we can assert a thrown exception:

@Test void whenAssertingException_thenThrown() { Throwable exception = assertThrows( IllegalArgumentException.class, () -> { throw new IllegalArgumentException("Exception message"); } ); assertEquals("Exception message", exception.getMessage()); }

The assertion will fail if no exception is thrown, or if an exception of a different type is thrown.

4.12. assertTimeout and assertTimeoutPreemptively

In case we want to assert that the execution of a supplied Executable ends before a given Timeout, we can use the assertTimeout assertion:

@Test public void whenAssertingTimeout_thenNotExceeded() { assertTimeout( ofSeconds(2), () -> { // code that requires less then 2 minutes to execute Thread.sleep(1000); } ); }

However, with the assertTimeout assertion, the supplied executable will be executed in the same thread of the calling code. Consequently, execution of the supplier won't be preemptively aborted if the timeout is exceeded.

In case we want to be sure that execution of the executable will be aborted once it exceeds the timeout, we can use the assertTimeoutPreemptively assertion.

И двете твърдения могат да приемат, вместо на Изпълнител, а ThrowingSupplier , представляващи всяко родово блок от код, който се връща обект и които могат потенциално да хвърлят Може да се изхвърли.

5. Заключение

В този урок разгледахме всички твърдения, налични както в JUnit 4, така и в JUnit 5.

Накратко подчертахме подобренията, направени в JUnit 5, с въвеждането на нови твърдения и подкрепата на ламбда.

Както винаги, пълният изходен код за тази статия е достъпен в GitHub.