Ejecutando Escenarios Cucumber con Serenity BDD y JUnit 5
Serenity BDD proporciona una integración perfecta con Cucumber, permitiéndote escribir especificaciones ejecutables en Gherkin y ejecutarlas usando JUnit 5. Esta guía cubre todo lo que necesitas saber para usar Cucumber con Serenity BDD y JUnit 5 de manera efectiva.
Descripción General
Cucumber es una herramienta popular de BDD (Desarrollo Guiado por Comportamiento) que te permite escribir escenarios de prueba en lenguaje natural usando la sintaxis Gherkin. Cuando se combina con Serenity BDD y JUnit 5, obtienes:
- Documentación Viva: Serenity genera reportes narrativos detallados a partir de tus escenarios Cucumber
- Ejecución de Pruebas Moderna: La potente plataforma de JUnit 5 para ejecutar pruebas
- Ejecución Paralela: Ejecuta escenarios en paralelo para una ejecución más rápida
- Reportes Detallados: Reportes de prueba detallados con capturas de pantalla, trazas de error y más
Prerrequisitos
Antes de comenzar, asegúrate de tener:
- Java 17 o superior
- Maven o Gradle
- Un IDE con soporte para Java (IntelliJ IDEA, Eclipse, VS Code, etc.)
Configuración de Dependencias
Dependencias Maven
Agrega las siguientes dependencias a tu pom.xml:
<properties>
<serenity.version>5.3.3</serenity.version>
<cucumber.version>7.33.0</cucumber.version>
<junit.version>6.0.1</junit.version>
</properties>
<dependencies>
<!-- Integración Serenity Cucumber -->
<dependency>
<groupId>net.serenity-bdd</groupId>
<artifactId>serenity-cucumber</artifactId>
<version>${serenity.version}</version>
<scope>test</scope>
</dependency>
<!-- Cucumber JUnit Platform Engine -->
<dependency>
<groupId>io.cucumber</groupId>
<artifactId>cucumber-junit-platform-engine</artifactId>
<version>${cucumber.version}</version>
<scope>test</scope>
</dependency>
<!-- JUnit Platform Suite -->
<dependency>
<groupId>org.junit.platform</groupId>
<artifactId>junit-platform-suite</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
</dependencies>
Dependencias Gradle
Para Gradle, agrega a tu build.gradle:
dependencies {
testImplementation "net.serenity-bdd:serenity-cucumber:5.3.3"
testImplementation "io.cucumber:cucumber-junit-platform-engine:7.33.0"
testImplementation "org.junit.platform:junit-platform-suite:6.0.1"
}
Creando un Test Runner Básico
La forma más simple de ejecutar escenarios Cucumber con JUnit 5 es crear una clase de suite de pruebas:
import org.junit.platform.suite.api.*;
@Suite
@IncludeEngines("cucumber")
@SelectClasspathResource("features")
class CucumberTestSuite {
}
Esta configuración mínima:
@Suite- Marca esto como una Suite de JUnit Platform@IncludeEngines("cucumber")- Indica a JUnit que use el motor de Cucumber@SelectClasspathResource("features")- Apunta al directorio que contiene tus archivos Feature
Configurando el Reporter de Serenity
La ruta del plugin de Serenity Cucumber cambió en la versión 5.0.0 de io.cucumber.core.plugin.* a net.serenitybdd.cucumber.core.plugin.*
Para generar reportes de Serenity, debes configurar el plugin reporter de Serenity. Agrega esto a tu suite de pruebas:
import org.junit.platform.suite.api.*;
import static io.cucumber.junit.platform.engine.Constants.PLUGIN_PROPERTY_NAME;
@Suite
@IncludeEngines("cucumber")
@SelectClasspathResource("features")
@ConfigurationParameter(
key = PLUGIN_PROPERTY_NAME,
value = "net.serenitybdd.cucumber.core.plugin.SerenityReporterParallel"
)
class CucumberTestSuite {
}
El plugin SerenityReporterParallel es seguro para hilos y se recomienda para todos los escenarios, incluso si no estás ejecutando pruebas en paralelo.
Opciones de Configuración
Usando Anotaciones @ConfigurationParameter
Puedes configurar varias opciones de Cucumber usando anotaciones @ConfigurationParameter. Aquí están las más comúnmente usadas:
Especificando Paquetes de Step Definition
import static io.cucumber.junit.platform.engine.Constants.GLUE_PROPERTY_NAME;
@ConfigurationParameter(
key = GLUE_PROPERTY_NAME,
value = "com.example.stepdefinitions"
)
Filtrando por Etiquetas
import static io.cucumber.junit.platform.engine.Constants.FILTER_TAGS_PROPERTY_NAME;
@ConfigurationParameter(
key = FILTER_TAGS_PROPERTY_NAME,
value = "@smoke and not @wip"
)
Especificando Rutas de Feature
import static io.cucumber.junit.platform.engine.Constants.FEATURES_PROPERTY_NAME;
@ConfigurationParameter(
key = FEATURES_PROPERTY_NAME,
value = "src/test/resources/features"
)
Ejemplo Completo
import org.junit.platform.suite.api.*;
import static io.cucumber.junit.platform.engine.Constants.*;
@Suite
@IncludeEngines("cucumber")
@SelectClasspathResource("features")
@ConfigurationParameter(
key = PLUGIN_PROPERTY_NAME,
value = "net.serenitybdd.cucumber.core.plugin.SerenityReporterParallel"
)
@ConfigurationParameter(
key = GLUE_PROPERTY_NAME,
value = "com.example.stepdefinitions"
)
@ConfigurationParameter(
key = FILTER_TAGS_PROPERTY_NAME,
value = "@smoke"
)
class SmokeTestSuite {
}
Usando junit-platform.properties
Alternativamente, puedes configurar las opciones de Cucumber en un archivo junit-platform.properties ubicado en src/test/resources:
# Habilitar Cucumber
cucumber.plugin=net.serenitybdd.cucumber.core.plugin.SerenityReporterParallel
cucumber.glue=com.example.stepdefinitions
cucumber.filter.tags=@smoke
cucumber.features=src/test/resources/features
# Orden de ejecución de escenarios
cucumber.execution.order=random
# Salida del plugin
cucumber.plugin=pretty,html:target/cucumber-reports/cucumber.html
- Usa
@ConfigurationParameterpara configuración específica de suite (ej., diferentes suites de prueba para smoke, regresión, etc.) - Usa
junit-platform.propertiespara configuración predeterminada del proyecto - Las anotaciones sobrescriben la configuración del archivo de propiedades
Organizando Archivos Feature
Estructura de Directorios
Serenity espera archivos Feature en src/test/resources/features por defecto. Organízalos jerárquicamente por área de funcionalidad:
src/test/resources/features/
├── authentication/
│ ├── login.feature
│ └── logout.feature
├── shopping/
│ ├── add_to_cart.feature
│ ├── checkout.feature
│ └── payment.feature
└── search/
├── basic_search.feature
└── advanced_filters.feature
Esta jerarquía se reflejará en tus reportes de Serenity, creando una estructura clara de requisitos.
Ejemplo de Archivo Feature
@shopping @checkout
Feature: Proceso de Checkout
Como cliente
Quiero completar mi compra
Para poder recibir mis artículos
Background:
Given I have items in my cart
@happy-path @smoke
Scenario: Checkout exitoso con tarjeta de crédito
When I proceed to checkout
And I enter valid shipping information
And I pay with a valid credit card
Then I should see an order confirmation
And I should receive a confirmation email
@edge-case
Scenario: Checkout con tarjeta de crédito inválida
When I proceed to checkout
And I enter valid shipping information
And I pay with an invalid credit card
Then I should see a payment error message
And my order should not be placed
Escribiendo Step Definition
Los Step Definition conectan tus escenarios Gherkin con código Java:
package com.example.stepdefinitions;
import io.cucumber.java.en.*;
import net.serenitybdd.screenplay.Actor;
import net.serenitybdd.screenplay.actors.OnStage;
public class CheckoutStepDefinitions {
@Given("{actor} has items in the cart")
public void hasItemsInCart(Actor actor) {
actor.attemptsTo(
// Tu implementación aquí
);
}
@When("{actor} proceeds to checkout")
public void proceedsToCheckout(Actor actor) {
actor.attemptsTo(
// Tu implementación aquí
);
}
@Then("{actor} should see an order confirmation")
public void shouldSeeOrderConfirmation(Actor actor) {
actor.should(
// Tus aserciones aquí
);
}
}
Mejores Prácticas para Step Definition
- Mantén los pasos reutilizables - Escribe pasos genéricos que puedan usarse en múltiples escenarios
- Usa el Screenplay Pattern - Para mejor mantenibilidad y legibilidad
- Evita la interdependencia de pasos - Cada paso debe ser independiente
- Usa parámetros - Haz los pasos flexibles con expresiones Cucumber
Filtrando Escenarios con Etiquetas
Expresiones de Etiquetas
Cucumber soporta expresiones de etiquetas potentes para filtrar escenarios:
# Ejecutar escenarios con etiqueta @smoke
mvn clean verify -Dcucumber.filter.tags="@smoke"
# Ejecutar escenarios con ambas etiquetas
mvn clean verify -Dcucumber.filter.tags="@smoke and @regression"
# Ejecutar escenarios con cualquiera de las etiquetas
mvn clean verify -Dcucumber.filter.tags="@smoke or @regression"
# Excluir escenarios
mvn clean verify -Dcucumber.filter.tags="not @wip"
# Expresiones complejas
mvn clean verify -Dcucumber.filter.tags="(@smoke or @regression) and not @slow"
En Código
@ConfigurationParameter(
key = FILTER_TAGS_PROPERTY_NAME,
value = "(@smoke or @regression) and not @wip"
)
En Archivo de Propiedades
cucumber.filter.tags=(@smoke or @regression) and not @wip
Ejecutando Escenarios en Paralelo
Consulta la guía dedicada de Ejecución Paralela para información detallada sobre cómo ejecutar escenarios Cucumber en paralelo.
Ejemplo rápido:
junit-platform.properties:
cucumber.execution.parallel.enabled=true
cucumber.execution.parallel.config.strategy=dynamic
cucumber.plugin=net.serenitybdd.cucumber.core.plugin.SerenityReporterParallel
Hooks de Cucumber
Los hooks de Cucumber te permiten ejecutar código antes o después de los escenarios:
package com.example.hooks;
import io.cucumber.java.*;
public class CucumberHooks {
@Before
public void beforeScenario(Scenario scenario) {
System.out.println("Iniciando escenario: " + scenario.getName());
}
@After
public void afterScenario(Scenario scenario) {
System.out.println("Escenario finalizado: " + scenario.getName());
if (scenario.isFailed()) {
// Manejar fallo
}
}
@BeforeStep
public void beforeStep() {
// Se ejecuta antes de cada paso
}
@AfterStep
public void afterStep() {
// Se ejecuta después de cada paso
}
}
Hooks con Etiquetas
Ejecuta hooks solo para etiquetas específicas:
@Before("@database")
public void setupDatabase() {
// Solo se ejecuta para escenarios etiquetados con @database
}
@After("@cleanup")
public void cleanup() {
// Solo se ejecuta para escenarios etiquetados con @cleanup
}