Mejores practicas
Esta guia cubre las mejores practicas para escribir pruebas de Serenity Playwright mantenibles, confiables y eficientes.
Arquitectura de pruebas
Sigue el patron de tres capas
Siempre estructura tu codigo en tres capas:
Pruebas (escenarios de negocio)
└── Step Library (reportes con @Step)
└── Page Object (localizadores y acciones)
Esta separacion proporciona:
- Mantenibilidad - Los cambios en la UI solo afectan a los Page Object
- Legibilidad - Las pruebas se leen como especificaciones
- Reusabilidad - Los pasos y Page Object se pueden compartir
Manten las pruebas enfocadas
Cada prueba debe verificar un comportamiento especifico:
// ❌ Mal: Probando demasiadas cosas
@Test
void testEverything() {
login();
searchForProduct();
addToCart();
checkout();
verifyOrderConfirmation();
logout();
verifyLoggedOut();
}
// ✅ Bien: Pruebas enfocadas
@Test
void shouldAddProductToCart() {
// Given
products.searchFor(page, "laptop");
// When
cart.addFirstResultToCart(page);
// Then
cart.verifyCartContains(page, "laptop");
}
@Test
void shouldCompleteCheckout() {
// Given
cart.hasItemsInCart(page);
// When
checkout.completeOrder(page);
// Then
checkout.verifyOrderConfirmation(page);
}
Gestion de navegadores
Comparte el navegador, aisla las paginas
Crea el navegador una vez por clase de prueba, pero crea una pagina nueva para cada prueba:
@ExtendWith(SerenityJUnit5Extension.class)
class ProductTests {
private static Playwright playwright;
private static Browser browser;
private Page page;
@BeforeAll
static void setupBrowser() {
// Crear navegador una vez - operacion costosa
playwright = Playwright.create();
browser = playwright.chromium().launch(
new BrowserType.LaunchOptions().setHeadless(true)
);
}
@AfterAll
static void closeBrowser() {
// Cerrar navegador despues de todas las pruebas
if (browser != null) browser.close();
if (playwright != null) playwright.close();
}
@BeforeEach
void setupPage() {
// Pagina nueva para cada prueba - aislamiento de pruebas
page = browser.newPage();
PlaywrightSerenity.registerPage(page);
}
@AfterEach
void closePage() {
// Limpiar despues de cada prueba
PlaywrightSerenity.unregisterPage(page);
if (page != null) page.close();
}
}
Usa contextos de navegador para aislamiento
Para aislamiento completo de pruebas, usa contextos de navegador:
@BeforeEach
void setup() {
// Cada contexto esta completamente aislado
BrowserContext context = browser.newContext();
page = context.newPage();
PlaywrightSerenity.registerPage(page);
}
@AfterEach
void cleanup() {
PlaywrightSerenity.unregisterPage(page);
BrowserContext context = page.context();
page.close();
context.close(); // Cierra todas las paginas y limpia cookies/storage
}
Extrae la configuracion comun a una clase base
Para reducir codigo repetitivo entre clases de prueba, crea una clase base que maneje el ciclo de vida de Playwright:
public abstract class SerenityPlaywrightTest {
protected Playwright playwright;
protected Browser browser;
protected Page page;
@BeforeEach
void setUpPlaywright() {
playwright = Playwright.create();
browser = playwright.chromium().launch(
new BrowserType.LaunchOptions().setHeadless(true)
);
page = browser.newPage();
PlaywrightSerenity.registerPage(page);
}
@AfterEach
void tearDownPlaywright() {
PlaywrightSerenity.unregisterPage(page);
if (page != null) page.close();
if (browser != null) browser.close();
if (playwright != null) playwright.close();
}
}
Las clases de prueba entonces extienden esta base y solo conectan sus Step Library:
@ExtendWith(SerenityJUnit5Extension.class)
@DisplayName("When adding todos")
class WhenAddingTodosTest extends SerenityPlaywrightTest {
@Steps
TodoSteps todo;
@BeforeEach
void setUp() {
todo.setPage(page); // Conectar Step Library a la pagina
}
@Test
void shouldAddTodoItem() {
todo.openApplication();
todo.addTodo("Buy milk");
assertThat(todo.visibleTodoCount()).isEqualTo(1);
}
}
Este patron:
- Centraliza la gestion del ciclo de vida - Los cambios en la configuracion del navegador solo necesitan hacerse en un lugar
- Asegura limpieza apropiada - La clase base garantiza que los recursos se liberen
- Reduce codigo repetitivo en clases de prueba - Cada clase de prueba se enfoca en la logica de prueba
- Hace la
pageaccesible - El campo protegido esta disponible para todas las subclases
Estrategias de localizacion
Prefiere localizadores resistentes
Usa localizadores en este orden de preferencia:
- Basados en rol - Mas resistentes, usan semantica de accesibilidad
- Basados en texto - Buenos para texto visible al usuario
- Basados en etiqueta - Buenos para campos de formulario
- Test ID - Buenos para elementos sin significado semantico
- CSS/XPath - Ultimo recurso
// 1. Basado en rol (mejor)
page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("Submit"));
// 2. Basado en texto
page.getByText("Add to Cart");
// 3. Basado en etiqueta
page.getByLabel("Email address");
// 4. Test ID
page.getByTestId("checkout-button");
// 5. CSS (evitar si es posible)
page.locator("button.submit-btn");
Evita localizadores fragiles
// ❌ Localizadores fragiles
page.locator("div:nth-child(3) > button");
page.locator(".btn-primary");
page.locator("//div[@class='container']/form/button[2]");
// ✅ Localizadores resistentes
page.getByRole(AriaRole.BUTTON, opts -> opts.setName("Place Order"));
page.getByTestId("place-order-button");
Usa localizadores encadenados para contexto
Cuando el mismo tipo de elemento aparece multiples veces:
// Encontrar el boton "Add" dentro de la primera tarjeta de producto
page.locator("[data-testid='product-card']").first()
.getByRole(AriaRole.BUTTON, new GetByRoleOptions().setName("Add"));
// Encontrar el campo email en la seccion de envio
page.locator("#shipping-section")
.getByLabel("Email");
Estrategias de espera
Confia en la espera automatica de Playwright
Playwright espera automaticamente a que los elementos sean accionables. No agregues esperas innecesarias:
// ❌ Innecesario - Playwright ya espera
Thread.sleep(2000);
page.locator("#button").waitFor();
page.locator("#button").click();
// ✅ Solo haz clic - Playwright espera automaticamente
page.locator("#button").click();
Usa esperas explicitas cuando sea necesario
Para condiciones especificas, usa esperas explicitas:
// Esperar a que la navegacion se complete
page.waitForURL("**/checkout");
// Esperar a que las peticiones de red terminen
page.waitForLoadState(LoadState.NETWORKIDLE);
// Esperar una condicion especifica
page.waitForCondition(() -> getItemCount() >= 5);
// Esperar a que un elemento se oculte
loadingSpinner().waitFor(new WaitForOptions()
.setState(WaitForSelectorState.HIDDEN));
Manejo de errores
Proporciona aserciones claras
Usa mensajes de asercion descriptivos:
@Step("Verify cart total is ${1}")
public void verifyCartTotal(Page page, BigDecimal expected) {
BigDecimal actual = cartPage.getTotal();
assertThat(actual)
.as("Cart total should be $%s but was $%s", expected, actual)
.isEqualByComparingTo(expected);
}
Maneja fallos esperados con elegancia
@Step("Verify error message is shown")
public void verifyErrorMessage(Page page, String expectedMessage) {
Locator errorLocator = page.locator(".error-message");
assertThat(errorLocator.isVisible())
.as("Error message should be visible")
.isTrue();
assertThat(errorLocator.textContent())
.as("Error message content")
.contains(expectedMessage);
}