Главная » Языки программирования

Java assert that example

Содержание
  1. Java Assert Keyword Example
  2. 1. Introduction
  3. 2. Java Assertion Example
  4. 3. Enabling and Disabling Assertions
  5. 4. When and Where to Use the assert keyword in Java
  6. 5. Where not to Use
  7. 6. Download the Source Code
  8. Примеры утверждений JUnit 5
  9. 1. assertEquals() и assertNotEquals()
  10. 2. assertArrayEquals()
  11. 3. assertIterableEquals()
  12. 4. assertLinesMatch()
  13. 5. assertNotNull() и assertNull()
  14. 6. assertNotSame() и assertSame()
  15. 7. assertTimeout() и assertTimeoutPreemptively()
  16. 8. assertTrue() и assertFalse()
  17. 9. assertThrows()
  18. 10. Пример fail()

Java Assert Keyword Example

In this article, we will explain what is the Assert Keyword in Java using examples. We will also create an example about assertion, that allows testing the correctness of any assumptions that have been made in a program.

1. Introduction

An assertion is achieved using the assert statement in Java. While executing an assertion, it is believed to be true. If it fails, JVM throws an error named AssertionError. It is mainly used for testing purposes during development.

The assert statement is used with a Boolean expression and can be written in two different ways. First way: assert expression;

2. Java Assertion Example

Now that we have known what the Java Assert is, let us programmatically understand it with the following coding snippet. AssertionInJava.java

// Java program to demonstrate syntax of assertion import java.util.Scanner; class Test < public static void main( String args[] ) < int a = 15; assert a >= 20 : " Underweight"; System.out.println("value of a is "+a); > >

Before Enabling Assertions: By default assertions are disabled. When we compile and run the above coding snippet using the commands javac AssertionInJava.java and java Test Output

After Enabling Assertions: When the Assertions are enabled and the output of the above coding snippet is as follows:

Exception in thread "main" java.lang.AssertionError: Underweight at Test.main(AssertionInJava.java:9)

The value of a is 15. The boolean expression along with the assert keyword evaluates to false so the compiler raises Assertion Error along with the message provided with the keyword.

Читайте также:  Проверить скорость работы php

3. Enabling and Disabling Assertions

By default, assertions are disabled. We need to run the code as given. The syntax for enabling the assertion statement in Java source code is: java –ea Test OR java –enableassertions Test where Test is the class name. The syntax for disabling assertions in java are: java –da Test OR java –disableassertions Test where Test is the class name.

4. When and Where to Use the assert keyword in Java

  • To make sure that an unreachable looking code is actually unreachable.
  • To make sure that assumptions written in comments are right.
  • To make sure the default switch case is not reached.
  • To check the object’s state.
  • At the beginning of the method
  • After method invocation.
  • Arguments to private methods. Private arguments are provided by the developer’s code only and the developer may want to check his/her assumptions about arguments.
  • Conditional cases.
  • Conditions at the beginning of any method.

5. Where not to Use

  • Assertions should not be used to replace error messages
  • Assertions should not be used to check arguments in the public methods as they may be provided by the user. Error handling should be used to handle errors provided by the user.
  • Assertions should not be used on command line arguments.

6. Download the Source Code

This is an example of how to use assertion in Java.

Источник

Примеры утверждений JUnit 5

Это продолжение туториала по JUnit 5. Введение опубликовано здесь.

Утверждения (Assertions) JUnit 5 помогают сравнить ожидаемый результат с фактическим результатом теста. Для простоты все утверждения JUnit Jupiter являются статическими методами в классе org.junit.jupiter.Assertions.

Не успешные утверждения будет генерировать исключение AssertionFailedError или его подкласс.

  1. assertEquals() и assertNotEquals()
  2. assertArrayEquals()
  3. assertIterableEquals()
  4. assertLinesMatch()
  5. assertNotNull() и assertNull()
  6. assertNotSame() и assertSame()
  7. assertTimeout() и assertTimeoutPreemptively()
  8. assertTrue() и assertFalse)
  9. assertThrows()
  10. Пример fail()

1. assertEquals() и assertNotEquals()

Метод Assertions.assertEquals() используется для подтверждения того, что ожидаемое и фактическое значения равны. Метод assertEquals() ммеет много перегруженных методов для разных типов данных, например, int, short, float, char и т. д. Он также выдает сообщения об ошибках, которые будут напечатаны в случае если тест будет неуспешным. например

Перегруженные методы

public static void assertEquals(int expected, int actual) public static void assertEquals(int expected, int actual, String message) public static void assertEquals(int expected, int actual, Supplier
void test() < //Тест пройдёт Assertions.assertEquals(4, Calculator.add(2, 2)); //Тест не пройдёт Assertions.assertEquals(3, Calculator.add(2, 2), "Calculator.add(2, 2) test failed"); //Тест не пройдёт SuppliermessageSupplier = () -> "Calculator.add(2, 2) test failed"; Assertions.assertEquals(3, Calculator.add(2, 2), messageSupplier); >

Точно так же метод Assertions.assertNotEquals() используется для утверждения, что ожидаемое и фактическое значения НЕ равны. В отличие от метода assertEquals() , assertNotEquals() не содержит перегруженных методов для разных типов данных, а только параметр типа Object принимается.

Перегруженные методы

public static void assertNotEquals(Object expected, Object actual) public static void assertNotEquals(Object expected, Object actual, String message) public static void assertNotEquals(Object expected, Object actual, Supplier messageSupplier)
void test() < //Тест пройдёт Assertions.assertNotEquals(3, Calculator.add(2, 2)); //Тест не пройдёт Assertions.assertNotEquals(4, Calculator.add(2, 2), "Calculator.add(2, 2) test failed"); //Тест не пройдёт SuppliermessageSupplier = () -> "Calculator.add(2, 2) test failed"; Assertions.assertNotEquals(4, Calculator.add(2, 2), messageSupplier); >

2. assertArrayEquals()

Метод assertArrayEquals() утверждает, что ожидаемый и фактический массивы равны.

Он также имеет перегруженные методы для различных типов данных, например, boolean[], char[], int[] и т. д. Он также выдает сообщения об ошибках, которые будут напечатаны в случае сбоя теста. например

Перегруженные методы

public static void assertArrayEquals(int[] expected, int[] actual) public static void assertArrayEquals(int[] expected, int[] actual, String message) public static void assertArrayEquals(int[] expected, int[] actual, Supplier messageSupplier)
void testCase() < //Тест пройдёт Assertions.assertArrayEquals(new int[], new int[], "Array Equal Test"); //Тест не пройден, потому что порядок элементов отличается Assertions.assertArrayEquals(new int[], new int[], "Array Equal Test"); //Тест не пройден, потому что количество элементов другое Assertions.assertArrayEquals(new int[], new int[], "Array Equal Test"); >

3. assertIterableEquals()

Метод assertIterableEquals() утверждает,, что ожидаемые и фактические итерации полностью равны. «Глубокое равенство» означает, что количество и порядок элементов в коллекции должны быть одинаковыми, а повторяющиеся элементы должны быть одинаковыми.

У него также есть три перегруженных метода.

Перегруженные методы

public static void assertIterableEquals(Iterable expected, Iterable> actual) public static void assertIterableEquals(Iterable expected, Iterable> actual, String message) public static void assertIterableEquals(Iterable expected, Iterable> actual, Supplier messageSupplier)
@Test void testCase() < IterablelistOne = new ArrayList<>(Arrays.asList(1,2,3,4)); Iterable listTwo = new ArrayList<>(Arrays.asList(1,2,3,4)); Iterable listThree = new ArrayList<>(Arrays.asList(1,2,3)); Iterable listFour = new ArrayList<>(Arrays.asList(1,2,4,3)); //Тест пройдёт Assertions.assertIterableEquals(listOne, listTwo); //Тест не пройдёт Assertions.assertIterableEquals(listOne, listThree); //Тест не пройдёт Assertions.assertIterableEquals(listOne, listFour); >

4. assertLinesMatch()

Он утверждает, что ожидаемый список строк соответствует фактическому списку. Логика сопоставления строки с другой строкой:

  1. проверьте, если expected.equals(actual) - если да, переходите к следующей паре
  2. в противном случае рассматривать expected как регулярное выражение и проверять переход String.matches(String) - если да, переходить к следующей паре
  3. в противном случае проверьте, является ли expected строка маркером быстрой перемотки вперед, если да, примените соответствующие строки быстрой перемотки вперед и перейдите к 1.

Допустимый маркер быстрой перемотки вперед - это строка, которая начинается и заканчивается >> и содержит не менее четырех символов. Любой символ между литералами быстрой перемотки вперед отбрасывается.

>>>> >> stacktrace >> >> single line, non Integer.parse()-able comment >>

5. assertNotNull() и assertNull()

AssertNotNull() утверждает, что фактическое значение НЕ равно нулю. Точно так же метод assertNull() утверждает, что это действительно так null . У обоих есть три перегруженных метода.

Перегруженные методы

public static void assertNotNull(Object actual) public static void assertNotNull(Object actual, String message) public static void assertNotNull(Object actual, Supplier messageSupplier) public static void assertEquals(Object actual) public static void assertEquals(Object actual, String message) public static void assertEquals(Object actual, Supplier messageSupplier)

6. assertNotSame() и assertSame()

assertNotSame() утверждает, что ожидаемый и фактический не относятся к одному объекту. Точно так же метод assertSame() утверждает, что ожидаемый и фактический относятся к одному и тому же объекту.

У обоих есть три перегруженных метода.

Перегруженные методы

public static void assertNotSame(Object expected, Object actual) public static void assertNotSame(Object expected, Object actual, String message) public static void assertNotSame(Object expected, Object actual, Supplier<> messageSupplier) public static void assertSame(Object expected, Object actual) public static void assertSame(Object expected, Object actual, String message) public static void assertSame(Object expected, Object actual, Supplier messageSupplier)

7. assertTimeout() и assertTimeoutPreemptively()

Методы assertTimeout() и assertTimeoutPreemptively() используются для тестирования долго выполняющихся задач. Если заданная задача в тесте занимает больше указанной продолжительности, тест завершится неудачно.

Единственная разница между обоими методами заключается в том, что в assertTimeoutPreemptively() выполнение Executable или ThrowingSupplier будет прервано с упреждением при превышении тайм-аута. В случае assertTimeout() , Executable или ThrowingSupplier не будет прервана.

Перегруженные методы

public static void assertTimeout(Duration timeout, Executable executable) public static void assertTimeout(Duration timeout, Executable executable, String message) public static void assertTimeout(Duration timeout, Executable executable, Supplier messageSupplier) public static void assertTimeout(Duration timeout, ThrowingSupplier supplier, String message) public static void assertTimeout(Duration timeout, ThrowingSupplier supplier, Supplier messageSupplier)
@Test void testCase() < //This will pass Assertions.assertTimeout(Duration.ofMinutes(1), () ->< return "result"; >); //This will fail Assertions.assertTimeout(Duration.ofMillis(100), () -> < Thread.sleep(200); return "result"; >); //This will fail Assertions.assertTimeoutPreemptively(Duration.ofMillis(100), () -> < Thread.sleep(200); return "result"; >); >

8. assertTrue() и assertFalse()

Метод assertTrue() утверждает, что предоставленное условие истинно или предоставленное логическое условие BooleanSupplier истинно.

Точно так же assertFalse() утверждает, что предоставленное условие ложно.

У обоих есть следующие перегруженные методы:

Перегруженные методы

public static void assertTrue(boolean condition) public static void assertTrue(boolean condition, String message) public static void assertTrue(boolean condition, Supplier messageSupplier) public static void assertTrue(BooleanSupplier booleanSupplier) public static void assertTrue(BooleanSupplier booleanSupplier, String message) public static void assertTrue(BooleanSupplier booleanSupplier, Supplier messageSupplier) public static void assertFalse(boolean condition) public static void assertFalse(boolean condition, String message) public static void assertFalse(boolean condition, Supplier messageSupplier) public static void assertFalse(BooleanSupplier booleanSupplier) public static void assertFalse(BooleanSupplier booleanSupplier, String message) public static void assertFalse(BooleanSupplier booleanSupplier, Supplier messageSupplier)
@Test void testCase() < boolean trueBool = true; boolean falseBool = false; Assertions.assertTrue(trueBool); Assertions.assertTrue(falseBool, "test execution message"); Assertions.assertTrue(falseBool, AppTest::message); Assertions.assertTrue(AppTest::getResult, AppTest::message); Assertions.assertFalse(falseBool); Assertions.assertFalse(trueBool, "test execution message"); Assertions.assertFalse(trueBool, AppTest::message); Assertions.assertFalse(AppTest::getResult, AppTest::message); >private static String message () < return "Test execution result"; >private static boolean getResult ()

9. assertThrows()

assetThrows() утверждает, что исполнение подаваемы Executable генерирует исключение из expectedType и возвращает исключение.

Перегруженные методы

public static T assertThrows(Class expectedType, Executable executable)

10. Пример fail()

Метод fail() делает тест неуспешным. Он имеет следующие перегруженные методы:

Перегруженные методы

public static void fail(String message) public static void fail(Throwable cause) public static void fail(String message, Throwable cause) public static void fail(Supplier messageSupplier)
public class AppTest < @Test void testCase() < Assertions.fail("not found good reason to pass"); Assertions.fail(AppTest::message); >private static String message () < return "not found good reason to pass"; >>

Источник

Оцените статью
© 2024 Программирование