¿Qué nos espera con JUnit 5?

Uno de los aspectos más importantes durante el desarrollo de cualquier aplicación es disponer de unas pruebas que detecten cualquier comportamiento anómalo en su funcionalidad.

Actualmente, en el mundo de Java, hay muchos frameworks de pruebas, algunos más conocidos que otros, y algunos más novedosos.

Quizá el más utilizado ha sido Junit, creado por Kent Beck, Erich Gamma y David Saff hace más de diez años. Desde la versión 4, creada en el año 2006, hasta la versión 4.12 (finales del 2014) han ido apareciendo otros frameworks (por ejemplo Spock) que han intentado “comerle el terreno”.

Debido a esto, los chicos de JUnit se han puesto las pilas para crear una nueva versión mayor de su producto, que es sobre la que vamos a hablar en este post.

En un principio la nombraron “Junit Lambda” (porque el cambio más grande es la introducción de lambdas en muchos sitios), pero finalmente se quedó con el nombre de JUnit 5.

Aunque estaba previsto que fuese liberada a finales de 2016, aún no está disponible y la fecha que se contempla actualmente es verano de este año.

No ha sido una buena noticia para los que teníamos ganas de probar la nueva versión. La parte positiva es que el equipo de JUnit 5 liberó a finales de noviembre la versión Milestone 3, así que además de adelantarnos la mayoría de las novedades ¡ya la podemos ir probando!

Pero antes de ver las novedades generales, analicemos la estructura del proyecto. Y es que JUnit ya no es una única biblioteca, sino que es un conjunto de tres subproyectos: JUnit Platform, JUnit Jupiter y JUnit Vintage.

JUnit Platform

JUnit Platform es la base que nos permite el lanzamiento de los frameworks de prueba en la JVM y, entre otras cosas, también es el encargado de proporcionarnos la posibilidad de lanzar la plataforma desde línea de comandos y de los plugins para Gradle y Maven.

JUnit Jupiter

JUnit Jupiter es el que más utilizaremos a la hora de programar. Nos permite utilizar el nuevo modelo de programación para la escritura de los nuevos tests de JUnit 5.

JUnit Vintage

Junit Vintage es el encargado de los tests de Junit 3 y 4, por si alguien los echa de menos.

Novedades

Paquetería

Uno de los cambios que menos nos gusta a los programadores es que para que JUnit 5 sea compatible con versiones antiguas, han creado la paquetería org.junit.jupiter para evitar colisiones. ¡Así que ojo con importar algo de org.junit en vez de del nuevo paquete!

Modificador de acceso public

Un cambio sutil, pero que a los fanáticos del diseño y de la semántica de los tests nos gusta, es que ni la clase de test ni los propios métodos necesitan ser públicos (tener el modificador de acceso public).

Esto no es un cambio respecto a la funcionalidad en sí, pero permite que la clases no puedan ser instanciadas ni sus métodos invocados desde fuera del propio framework de JUnit 5.


class MyTest {
   @Test
   void allwaysOk() {
       assertTrue(true);
   }
}

Nombrar tests

Algunos programadores se quejaban de los nombres sumamente descriptivos que se le ponen a los métodos porque terminaban con nombres muy largos.

Probablemente por esto, el equipo de JUnit decidió agregar la anotación @DisplayName, que nos permite dar un nombre más amistoso tanto a clases como a métodos.

La utilidad que tiene esto es que las herramientas que nos muestran los tests lo hagan con el nombre de la anotación en vez de con el propio nombre de la clase o el método.


@DisplayName("My test examples")
class MyTest {
  @Test
  @DisplayName("The test that always is OK")
  void allwaysOk() {
     assertTrue(true);
  }
  @Test
  @DisplayName("The test that always fails")
  void allwaysKo() {
     assertTrue(false);
  }
}

Aunque esto sirve de excusa para cambiar el nombre de los métodos por cosas menos descriptivas como “test1()” en vez de “allwaysOk()”, no recomiendo que se tienda a hacer nombres de métodos pocos descriptivos.

Los nombres de los test deberían seguir sirviendo para documentar el código que prueban, ya que desde el equipo de JUnit no pueden asegurar que el IDE que estás utilizando para ejecutar tus tests sea capaz de leer el nombre que tú has establecido con la anotación @DisplayName.

Yo soy partidario de seguir el patrón BDD a la hora de nombrar los test, siguiendo el patrón Given-When-Then, como por ejemplo “givenNameAndAddressThenBuildPerson()”, y utilizar @DisplayName para agregar documentación al test, como por ejemplo “Given name and address then build the person with this values”.

Pero también es cierto que es trabajo doble por lo que, en mi opinión, quizás esta anotación no tenga gran utilidad. Aún así, es mejor tener la opción y no usarla, que querer hacerlo y no poder.

Lo más divertido de dar nombre a los test es que se pueden poner emoticonos, como por ejemplo con @DisplayName("?"). Realmente no sé si esto es bueno o malo porque todos sabemos que en algún momento nos vamos a encontrar un informe de fallos de los test llenos de emoticonos.

Aserciones de excepciones

Antes la forma de comprobar que un método devolvía una excepción consistía en: o bien agregar esa información en una anotación a nivel de método, o bien capturar la excepción y chequearla manualmente (eso solía quedar bastante sucio).

Ahora tenemos otras posibilidades, como por ejemplo utilizar el método “assertThrows()”, que recibe la excepción que se espera recibir y un Executable, que debería invocar al código que queremos comprobar si lanza una excepción.

Después, capturada la respuesta del método “assertThrows()”, dispondríamos de la excepción para hacer tantas aserciones en ella como queramos, con la seguridad de que la excepción se ha lanzado, ya que el propio método comprueba que así sea.


@Test
@DisplayName("Check the expectThrows")
void checkExceptions(){
   String message = "Paradigma rules!";
   Throwable exception = assertThrows(IllegalArgumentException.class, () -&gt; {
       throw new IllegalArgumentException(message);
   });
   assertEquals(message, exception.getMessage());
}
@Test
@DisplayName("Check the expectThrows if there is no exception throwed")
void checkExceptionNotThrowed(){
   String message = "Paradigma rules!";
   Throwable exception = assertThrows(IllegalArgumentException.class, () -&gt; {});
   assertEquals(message, exception.getMessage());
}

Ojo, que en mucha documentación previa a la versión M3, se dice que se utilice el método expectThrows, pero este está deprecado a favor del método assertThrows.

Aserciones múltiples

Muchas veces, a la hora de hacer tests, nos encontrábamos con el problema de tener que ejecutar una gran cantidad de aserciones, que la primera de ellas fallase y no saber si las siguientes eran correctas o no.

Esto con JUnit no pasa, gracias a esta funcionalidad que nos permite ejecutar una colección de aserciones y mostrar todos los errores de estas en el reporte.

El método assertAll recibe, además de un String con el mensaje en caso de que falle la aserción, un N Executable o un Stream, siendo Executable una interfaz funcional del propio API de JUnit 5. Por lo que podemos utilizar lambdas para cada una de las aserciones que queramos que compruebe el assertAll.


assertAll("Try multiple things",
       () -&gt; assertTrue(true),
       () -&gt; assertTrue(false),
       () -&gt; assertEquals(1, 1),
       () -&gt; assertEquals(1, 2),
       () -&gt; assertEquals(5, 2));

Este código nos mostrará, además de las trazas de las excepciones, información sobre cada una de las aserciones que han fallado, lo que nos permite comprobar a la vez varias aserciones independientemente de que una o varias fallen.

org.opentest4j.MultipleFailuresError: Try multiple things (3 failures)
  in org.opentest4j.AssertionFailedError
 expected:  but was: 
 expected:  but was:

Aserciones de timeouts

¿Alguna vez te has planteado que un error se deba a que cierta funcionalidad tarda mucho en ejecutarse? Yo sí y JUnit nos da una respuesta mediante el método assertTimeout o assertTimeoutPreemptively, a los que se les debe especificar el tipo de Duration que queremos que se compruebe, la cantidad y, en una lambda, el código a probar en ese tiempo.


@Test
void timeoutSuccess(){
   assertTimeout(Duration.ofMinutes(1), ()-&gt;{});
}
@Test
void timeoutFailed(){
   assertTimeout(Duration.ofMillis(1), ()-&gt;Thread.sleep(100));
}

Una herramienta muy útil si uno de los requisitos que medimos es su tiempo de ejecución.

La diferencia entre estas dos aserciones es que assertTimeout espera a que el código que se estaba comprobando termine, incluso nos indica por cuánto tiempo ha fallado el test. Mientras tanto, assertTimeoutPreemptively aborta el proceso una vez se excede el tiempo.

Mensajes de aserciones como lambdas

Muchas veces no nos acordamos de pequeños detalles, como el uso de memoria al utilizar String. JUnit 5 piensa por nosotros, así que nos permite utilizar lambdas para generar los mensajes de error de las aserciones, de forma que estos mensajes no sean instanciados a menos que sea necesario. Esto evita construir mensajes complejos en memoria si la aserción es correcta, y solo lo hace en caso de error.


assertTrue(true, () -&gt; "It will never shown and build");

Deshabilitar en vez de ignorar

Aunque a menudo nos sintamos mal por ignorar test, cuando lo hagamos con JUnit 5 debemos recordar que ahora los test no se ignoran, sino que se deshabilitan; que es lo mismo, pero con distintas palabras.

Es decir, en vez de tener que poner @Ignore, ahora habrá que escribir @Disabled, y que podemos ponerlo tanto a nivel de clase como de método, incluso en “inner classes” de las que hablaremos más adelante.

Test en inner classes

Con esta versión también se agrega la posibilidad de probar “inner classes” para estructurar mejor nuestras clases de tests. Para esto habrá que agregar una inner class y anotarla con @Nested.

Después, simplemente crearemos los métodos que queremos probar dentro de la inner class, o incluso crear otra inner class en su interior, anidando todas las que consideremos correctas.


@DisplayName("My test examples")
class MyTest {
       @Nested
       class InnerClass{
         @Test
         @DisplayName("InnerClass - The test that always is OK")
         void allwaysOk() {
           assertTrue(true);
         }
         @Test
         @DisplayName("InnerClass - The test that always fails")
         void allwaysKo() {
           assertTrue(false);
         }
        }
}

Esto permitirá a algunos IDE’s colocar los resultados de los test anidados de forma que quede más claro y ordenado.

Nota: Aunque lo repitamos más adelante, las inner class tienen la limitación de que al no poder crear métodos estáticos, no podemos utilizar la anotación @BeforeAll ni @AfterAll.

Asunciones

Aunque no es muy conocido, en JUnit 4 ya encontraron la solución al problema de que parte de nuestros test se ejecutaran sólo en determinadas circunstancias.

Esto está resuelto con las asunciones, que permiten decidir si cierta parte del código se debe ejecutar o no dependiendo de ciertas excepciones.

Al igual que ha ocurrido con los mensajes de las aserciones, JUnit 5 nos permite introducir lambdas con el código que queremos que se ejecute sólo en caso de que la asunción sea correcta.


@Test
void tryAssumeTrue() {
   assumeTrue(true,
           () -&gt; "Message that will be never shown");
   assumeTrue(false,
           () -&gt; "Message that will be shown because the assumtion is true");
}
@Test
void tryAssumeThat() {
   assumingThat(true,
           () -&gt; assertEquals(1, 2, ()-&gt;"Only tested if the assumtion is true"));
}

Cambios de nombres del ciclo de vida

Este es un cambio menor, aunque en mi opinión bastante bueno, ya que aclara el manejo de los métodos que queremos que se lancen en un test teniendo en cuenta su ciclo de vida.

Son las anotaciones: @BeforeEach, @AfterEach, @BeforeAll, @AfterAll que sustituyen a las anotaciones de JUnit 4 @Before, @After, @BeforeClass, @AfterClass respectivamente, siendo los nuevos nombres bastantes más descriptivos:

Si dividimos las palabras de las nuevas anotaciones para comprender su funcionamiento, “Before” y “After” hacen referencia a si se ejecuta antes o después.
“Each” se refiere a que será antes o después de cada uno de los tests
“All” que será antes o después e la ejecución del conjunto de todos los tests de la clase.

Las anotaciones del ciclo de vida “All” no pueden utilizarse en clases anotadas con @Nested, ya que al ser inner classes, no permiten el uso de métodos estáticos.

Aserciones con bibliotecas de terceros

Si bien con JUnit 4 disponíamos de una integración directa para utilizar bibliotecas de terceros para hacer nuestras aserciones, por ejemplo con “assertThat()”, la nueva versión no dispone de una integración directa con estas bibliotecas.

Pese a esto, JUnit 5 permite utilizar directamente estas bibliotecas sin disponer de un método que los haga compatibles.

En la propia documentación ejemplifican cómo hacerlo:


import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import org.junit.jupiter.api.Test;
class HamcrestAssertionDemo {
    @Test
    void assertWithHamcrestMatcher() {
        assertThat(2 + 1, is(equalTo(3)));
    }
}

Inyección de dependencias

Sí, el equipo de JUnit 5 ha hecho uno de los mayores cambios del framework: inyección de dependencias, una funcionalidad demandada ya en la anterior versión pero imposible de llevar a cabo porque era necesario utilizar otros runner.

Con esta nueva funcionalidad podemos agregar parámetros de entrada al constructor de la clase de test o a cualquier método anotado con:

@Test
@TestFactory
@BeforeEach
@AfterEach
@BeforeAll o @AfterAll

Aunque no podemos inyectar cualquier valor, disponemos de un par de objetos bastante útiles, además de la posibilidad de agregar cualquier objeto a la clase de test o al método anotado de una forma más complicada:

TestInfo: Podemos inyectar este objeto, que dispone de datos sobre la propia ejecución del test.
getDisplayName(): Devuelve el nombre del test que esté puesto en la anotación de @DisplayName o el nombre del método en caso de que no exista.
getTags(): Devuelve una colección con todos los tags que estén afectado al método, tanto las anotaciones @Tag directamente sobre ese método como sobre la clase, sobre la clase que contiene la inner class que contiene el método… y así hasta que el grado de profundidad de métodos, inner classes y la clase principal dejen la película de Origen como un juego de niños.
getTestClass(): Devuelve la clase propietaria del método que se está ejecutando.
getTestMethod(): Devuelve el método que se está ejecutando.


@Test
@DisplayName("Test things about the TestInfo")
@Tag("ParadigmaTest")
void testInfoThings(TestInfo testInfo) {
   assertEquals("Test things about the TestInfo", testInfo.getDisplayName());
   assertTrue(testInfo.getTags().contains("ParadigmaTest"));
}

TestReporter: Nos permite modificar o agregar información sobre la ejecución del test. Esta clase dispone de dos métodos, uno para publicar un mapa de clave-valor y otro para un único conjunto de clave valor.
Otros: Para agregar otros parámetros, hay que extender el inyector de JUnit 5 con la anotación @ExtendedWith, indicando la clase que extiende la inyección. Para más información, recomiendo leer la propia documentación de JUnit al respecto. Un ejemplo puede verse si utilizamos MockitoExtension, que actualmente está en este repositorio.

 org.mockito
 mockito-core
 2.6.3


interface Developer{
   String getName();
}
@ExtendWith(MockitoExtension.class)
class MyMockitoTest {
   @BeforeEach
   void init(@Mock Developer person) {
       when(person.getName()).thenReturn("Alberto");
   }
   @Test
   void simpleTestWithInjectedMock(@Mock Developer person) {
       assertEquals("Alberto", person.getName());
   }
}

Métodos default de interfaces

JUnit aporta también una nueva funcionalidad: la posibilidad de crear tests basándonos en los default method agregados en Java 8. De forma que, agregando la implementación de un par de métodos, se realiza una serie de test más potentes.

El ejemplo que nos da la documentación de JUnit es bastante bueno en este aspecto, ya que nos permite crear una interfaz para probar el método equals() de una clase y otra para el compareTo().

La idea consiste en crear una interfaz con un método para crear una instancia básica del objeto a probar y posteriormente extenderlo con la interfaz, que nos probará el equals() y con la interfaz que lo hará con el compareTo().


public interface Testable&lt;T&gt; {
   T createValue();
}

La interfaz que probará el equals dejará a implementar un método para crear una instancia distinta a la básica, y luego se escribirán los distintos métodos para comprobar la funcionalidad del equals.


public interface EqualsContract&lt;T&gt; extends Testable&lt;T&gt; {
   T createNotEqualValue();
   @Test
   default void valueEqualsItself() {
       T value = createValue();
       assertEquals(value, value);
   }
   @Test
   default void valueDoesNotEqualNull() {
       T value = createValue();
       assertFalse(value.equals(null));
   }
   @Test
   default void valueDoesNotEqualDifferentValue() {
       T value = createValue();
       T differentValue = createNotEqualValue();
       assertNotEquals(value, differentValue);
       assertNotEquals(differentValue, value);
   }
}

Y para probar el compareTo(), se hará una interfaz con un método para crear una instancia menor a la básica, además de, nuevamente, agregar las implementaciones por defecto de una serie de tests que nos permitirán comprobar todas las casuísticas.


public interface ComparableContract&lt;T extends Comparable&lt;T&gt;&gt; extends Testable&lt;T&gt; {
   T createSmallerValue();
   @Test
   default void returnsZeroWhenComparedToItself() {
       T value = createValue();
       assertEquals(0, value.compareTo(value));
   }
   @Test
   default void returnsPositiveNumberComparedToSmallerValue() {
       T value = createValue();
       T smallerValue = createSmallerValue();
       assertTrue(value.compareTo(smallerValue) &gt; 0);
   }
   @Test
   default void returnsNegativeNumberComparedToSmallerValue() {
       T value = createValue();
       T smallerValue = createSmallerValue();
       assertTrue(smallerValue.compareTo(value) &lt; 0);
   }
}

De esta forma es muy sencillo hacer distintos tests para probar las comparaciones y las igualdades.


class StringTests implements ComparableContract&lt;String&gt;, EqualsContract&lt;String&gt; {
   @Override
   public String createValue() {
       return "Speaker for the Dead";
   }
   @Override
   public String createSmallerValue() {
       return "Ender’s Game";
   }
   @Override
 public String createNotEqualValue() {
       return "Xenocide";
   }
}
@Nested
class IntegerTests implements ComparableContract&lt;Integer&gt;, EqualsContract&lt;Integer&gt; {
   @Override
   public Integer createValue() {
       return 42;
   }
   @Override
   public Integer createSmallerValue() {
       return 13;
   }
   @Override
   public Integer createNotEqualValue() {
       return 54;
   }
}

Test dinámicos

Otra de las grandes novedades de JUnit 5 son los test dinámicos. Hasta ahora los test se construían en tiempo de compilación, mientras que con esta novedad podemos hacerlo en tiempo de ejecución.

Para poder crear estos tests, por ahora (aunque está previsto que en la Release haya más formas), hay que crearlos a través de un @TestFactory, una anotación a nivel de método que nos permite crear un test que será autoejecutado de forma perezosa.

Cabe destacar que para los test creados con la factoría, las anotaciones @BeforeEach y @AfterEach no tienen ninguna utilidad, ya que no nos permiten modificar nada del comportamiento.

Debido a que este aspecto parece el más propenso a sufrir modificaciones desde esta versión M3 a la Release, sugiero comprobar en la documentación de JUnit.

Los test dinámicos están formados por un nombre y una implementación de la interfaz funcional Executable, que será la que tenga la ejecución del propio test. Esta implementación puede, y casi debe, ser una lambda.

Además, cualquier factoría de tests debe devolver o bien una colección de DynamicTest o un stream de los mismos, ya que serán los que se irán ejecutando.


@TestFactory
Collection&lt;DynamicTest&gt; dynamicTestWithCollection() {
   return Arrays.asList(
           dynamicTest("1st case", () -&gt; assertTrue(true)),
           dynamicTest("2nd case", () -&gt; assertEquals(1, 1))
   );
}
@TestFactory
Stream&lt;DynamicTest&gt; givenNumberTestIfTheyArePair() {
   return Stream.of(2, 4, 6).map(
           f -&gt; dynamicTest("Given " +f+" test that it is pair", () -&gt; Assert.assertEquals(0,f%2)));
}

¿Cómo lo voy probando?

Llegados a este punto espero que a la mayoría, como me ocurrió a mí, os hayan entrado ganas de trastear con JUnit 5 para ir mitigando las ganas de tener entre nuestros teclados la primera release.

En el momento de escribir este post, el único IDE que he comprobado que tiene integración con JUnit 5 es IntelliJ IDEA. Entiendo que en un futuro todos lo tendrán. Hasta entonces tenemos la opción de lanzar la ejecución por consola o utilizar el IntelliJ.

Eso sí, y esto es muy importante, JUnit 5 no soporta ninguna versión de Java inferior a la 8.

Aunque, por supuesto, también puede hacerse con Gradle. En mi caso he hecho todas las pruebas con maven agregando el plugin.

maven-surefire-plugin
2.19.1

\
\*\*/Test\*.java
\*\*/\*Test.java
\*\*/\*Tests.java
\*\*/\*TestCase.java

\
\

org.junit.platform
junit-platform-surefire-provider
1.0.0-M3

org.junit.jupiter
junit-jupiter-engine
5.0.0-M3

org.junit.vintage
junit-vintage-engine
4.12.0-M3

Además de las dependencias, por supuesto:

org.junit.jupiter
junit-jupiter-api
5.0.0-M3
test

junit
junit
4.12
test

Y si os interesa hacer funcionar JUnit 5 con un proyecto Gradle, podéis echar un ojo a la documentación oficial.

@AfterAll

Si después de todo lo que he explicado en este post tenéis dudas o inquietudes, lo cierto es que el manual de usuario de JUnit es bastante completo. De hecho, es la fuente principal que he utilizado para escribir este post, por lo que os recomiendo visitarlo.

También, si sois muy inquietos y os interesa echar un ojo a su código, podéis hacerlo en su repositorio de Github. También tenemos accesible el javadoc.

Alberto Cebrián

Arquitecto de software y friki en toda regla, apasionado por lo creativo, imaginativo y diferente. Siempre dispuesto a aprender sobre nuevas tecnologías y metodologías de trabajo. Me encanta terminar el día aprendiendo algo nuevo.

Ver más contenido de Alberto.

Más contenido sobre esto.

JIO II: Java Contraataca

JIO II: Java Contraataca.

Por Rafael Merino

Desmitificando getters y setters

Desmitificando getters y setters.

Por José Luis Canales

¿Eres un programador Java o un Hipster?

Por Abraham Rodríguez

Testcontainers, entornos de testing efímeros

Testcontainers, entornos de testing efímeros.

Por Raúl Martínez

Cuéntanos qué te parece.

Los comentarios serán moderados. Serán visibles si aportan un argumento constructivo. Si no estás de acuerdo con algún punto, por favor, muestra tus opiniones de manera educada.