Construcción y Pruebas

Esta página explica cómo construir Fess, métodos de prueba, y cómo crear paquetes de distribución.

Visión General del Sistema de Construcción

Fess usa Maven como herramienta de construcción. Maven automatiza la gestión de dependencias, compilación, pruebas y empaquetado.

pom.xml

Este es el archivo de configuración de Maven. Se encuentra en el directorio raíz del proyecto.

Contenido de configuración principal:

Información del proyecto (groupId, artifactId, version)
Bibliotecas de dependencias
Plugins de construcción
Perfiles

Comandos Básicos de Construcción

Construcción Limpia

Elimina artefactos de construcción y luego reconstruye:

Creación de Paquetes

Crea un archivo WAR y un paquete zip de distribución:

Los artefactos se generan en el directorio target/:

Construcción Completa

Ejecuta limpieza, compilación, pruebas y empaquetado:

Descarga de Dependencias

Descarga bibliotecas de dependencias:

Descarga de Plugins de OpenSearch

Descarga OpenSearch y plugins obligatorios:

Nota

Ejecute este comando al configurar el entorno de desarrollo o al actualizar plugins.

Pruebas

Fess implementa pruebas usando JUnit.

Ejecución de Pruebas Unitarias

Ejecutar Todas las Pruebas Unitarias

Ejecutar Clase de Prueba Específica

Ejecutar Método de Prueba Específico

Ejecutar Múltiples Clases de Prueba

Omitir Pruebas

Para construir omitiendo pruebas:

Advertencia

Durante el desarrollo, no omita las pruebas, ejecútelas siempre. Antes de crear un PR, verifique que todas las pruebas pasen.

Ejecución de Pruebas de Integración

Las pruebas de integración requieren el perfil integrationTests. Se necesita un servidor Fess y OpenSearch en ejecución:

Nota

Las clases de pruebas de integración usan el patrón *Tests.java (las unitarias usan *Test.java).

Cómo Escribir Pruebas

Creación de Pruebas Unitarias

Ubicación de Clases de Prueba

Coloque las clases de prueba bajo src/test/java/. La estructura de paquetes debe ser la misma que el código principal.

Estructura Básica de Clase de Prueba

package org.codelibs.fess.app.service;

import org.junit.jupiter.api.Test;
import static org.junit.jupiter.api.Assertions.*;

public class SearchServiceTest {

    @Test
    public void testSearch() {
        // Given: Condiciones previas de la prueba
        SearchService service = new SearchService();
        String query = "test";

        // When: Ejecución del objetivo de prueba
        SearchResponse response = service.search(query);

        // Then: Verificación de resultados
        assertNotNull(response);
        assertTrue(response.getResultCount() > 0);
    }
}

Ciclo de Vida de las Pruebas

import org.junit.jupiter.api.*;

public class MyServiceTest {

    @BeforeAll
    static void setUpClass() {
        // Ejecutar una vez antes de todas las pruebas
    }

    @BeforeEach
    void setUp() {
        // Ejecutar antes de cada prueba
    }

    @Test
    void testSomething() {
        // Prueba
    }

    @AfterEach
    void tearDown() {
        // Ejecutar después de cada prueba
    }

    @AfterAll
    static void tearDownClass() {
        // Ejecutar una vez después de todas las pruebas
    }
}

Aserciones

Use aserciones de JUnit 5:

import static org.junit.jupiter.api.Assertions.*;

// Igualdad
assertEquals(expected, actual);
assertNotEquals(unexpected, actual);

// Verificación de null
assertNull(obj);
assertNotNull(obj);

// Valores booleanos
assertTrue(condition);
assertFalse(condition);

// Excepciones
assertThrows(IllegalArgumentException.class, () -> {
    service.doSomething();
});

// Colecciones
assertIterableEquals(expectedList, actualList);

Construcción
Pruebas unitarias
Creación de paquetes

Error: Versión antigua de Java

Use Java 21 o posterior:

Errores de Prueba

Las pruebas agotan el tiempo de espera

Extender tiempo de espera de pruebas:

OpenSearch no se inicia

Verifique el puerto y cámbielo si está en uso:

Problemas de Dependencias

Conflictos de dependencias

Verifique árbol de dependencias:

Excluir dependencia específica:

<dependency>
    <groupId>org.example</groupId>
    <artifactId>example-lib</artifactId>
    <version>1.0</version>
    <exclusions>
        <exclusion>
            <groupId>conflicting-lib</groupId>
            <artifactId>conflicting-lib</artifactId>
        </exclusion>
    </exclusions>
</dependency>

# Limpiar
mvn clean

# Compilar
mvn compile

# Probar
mvn test

# Empaquetar
mvn package

# Instalar (registrar en repositorio local)
mvn install

# Verificar (incluye pruebas de integración)
mvn verify

# Resolver dependencias
mvn dependency:resolve

# Mostrar árbol de dependencias
mvn dependency:tree

# Mostrar información del proyecto
mvn help:effective-pom

# Formateo de código
mvn formatter:format

# Agregar encabezados de licencia
mvn license:format

Próximos Pasos

Una vez que comprenda los métodos de construcción y prueba, consulte los siguientes documentos:

Flujo de Trabajo de Desarrollo - Flujo de trabajo de desarrollo
Guía de Contribución - Directrices de contribución
Arquitectura y Estructura del Código - Comprensión del código base