Avertissement

Pendant le développement, n’ignorez pas les tests et exécutez-les toujours. Avant de créer une PR, vérifiez que tous les tests passent.

Exécution des tests d’intégration

Les tests d’intégration nécessitent le profil integrationTests. Un serveur Fess et OpenSearch en cours d’exécution sont requis :

Note

Les classes de tests d’intégration utilisent le modèle *Tests.java (les tests unitaires utilisent *Test.java).

Rédaction de tests

Création de tests unitaires

Placement des classes de tests

Placez les classes de tests sous src/test/java/. La structure des packages doit être la même que le code principal.

Structure de base de la classe de test

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: Conditions préalables du test
        SearchService service = new SearchService();
        String query = "test";

        // When: Exécution du sujet du test
        SearchResponse response = service.search(query);

        // Then: Vérification des résultats
        assertNotNull(response);
        assertTrue(response.getResultCount() > 0);
    }
}

Cycle de vie des tests

import org.junit.jupiter.api.*;

public class MyServiceTest {

    @BeforeAll
    static void setUpClass() {
        // Exécuté une fois avant tous les tests
    }

    @BeforeEach
    void setUp() {
        // Exécuté avant chaque test
    }

    @Test
    void testSomething() {
        // Test
    }

    @AfterEach
    void tearDown() {
        // Exécuté après chaque test
    }

    @AfterAll
    static void tearDownClass() {
        // Exécuté une fois après tous les tests
    }
}

Assertions

Utilisez les assertions de JUnit 5 :

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

// Égalité
assertEquals(expected, actual);
assertNotEquals(unexpected, actual);

// Vérification null
assertNull(obj);
assertNotNull(obj);

// Valeur booléenne
assertTrue(condition);
assertFalse(condition);

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

// Collections
assertIterableEquals(expectedList, actualList);

Compilation
Tests unitaires
Création de packages

Erreur : Version Java obsolète

Utilisez Java 21 ou supérieur :

Erreurs de test

Les tests expirent

Prolongez le délai d’expiration des tests :

OpenSearch ne démarre pas

Vérifiez les ports et changez-les s’ils sont utilisés :

Problèmes de dépendances

Conflits de dépendances

Vérifiez l’arbre des dépendances :

Exclure une dépendance spécifique :

<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>

# Clean
mvn clean

# Compilation
mvn compile

# Tests
mvn test

# Package
mvn package

# Installation (enregistrement dans le dépôt local)
mvn install

# Vérification (y compris les tests d'intégration)
mvn verify

# Résolution des dépendances
mvn dependency:resolve

# Affichage de l'arbre des dépendances
mvn dependency:tree

# Affichage des informations du projet
mvn help:effective-pom

# Formatage du code
mvn formatter:format

# Ajout des en-têtes de licence
mvn license:format

Étapes suivantes

Après avoir compris les méthodes de compilation et de test, consultez la documentation suivante :

Flux de travail de développement - Flux de travail de développement
Guide de contribution - Directives de contribution
Architecture et structure du code - Compréhension du code source