Warnung

Überspringen Sie während der Entwicklung keine Tests, sondern führen Sie sie immer aus. Stellen Sie vor dem Erstellen eines PR sicher, dass alle Tests bestehen.

Ausführen von Integrationstests

Für Integrationstests wird das Profil integrationTests verwendet. Ein laufender Fess-Server und OpenSearch sind erforderlich:

Bemerkung

Integrationstestklassen verwenden das Namensmuster *Tests.java (Unit-Tests verwenden *Test.java).

Schreiben von Tests

Erstellen von Unit-Tests

Platzierung von Testklassen

Platzieren Sie Testklassen unter src/test/java/. Die Paketstruktur sollte mit dem Hauptcode übereinstimmen.

Grundstruktur einer Testklasse

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: Testvoraussetzungen
        SearchService service = new SearchService();
        String query = "test";

        // When: Ausführung des Testobjekts
        SearchResponse response = service.search(query);

        // Then: Überprüfung der Ergebnisse
        assertNotNull(response);
        assertTrue(response.getResultCount() > 0);
    }
}

Test-Lebenszyklus

import org.junit.jupiter.api.*;

public class MyServiceTest {

    @BeforeAll
    static void setUpClass() {
        // Einmal vor allen Tests ausführen
    }

    @BeforeEach
    void setUp() {
        // Vor jedem Test ausführen
    }

    @Test
    void testSomething() {
        // Test
    }

    @AfterEach
    void tearDown() {
        // Nach jedem Test ausführen
    }

    @AfterAll
    static void tearDownClass() {
        // Einmal nach allen Tests ausführen
    }
}

Assertions

Verwenden Sie JUnit 5-Assertions:

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

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

// Null-Prüfung
assertNull(obj);
assertNotNull(obj);

// Boolean-Werte
assertTrue(condition);
assertFalse(condition);

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

// Collections
assertIterableEquals(expectedList, actualList);

Build
Unit-Tests
Paketerstellung

Fehler: Java-Version ist veraltet

Verwenden Sie Java 21 oder höher:

Test-Fehler

Test läuft in Timeout

Verlängern Sie die Test-Timeout-Zeit:

OpenSearch startet nicht

Überprüfen Sie den Port und ändern Sie ihn, wenn er verwendet wird:

Abhängigkeitsprobleme

Abhängigkeitskonflikte

Überprüfen Sie den Abhängigkeitsbaum:

Schließen Sie bestimmte Abhängigkeiten aus:

<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

# Kompilieren
mvn compile

# Testen
mvn test

# Paketieren
mvn package

# Installieren (im lokalen Repository registrieren)
mvn install

# Überprüfen (einschließlich Integrationstests)
mvn verify

# Abhängigkeiten auflösen
mvn dependency:resolve

# Abhängigkeitsbaum anzeigen
mvn dependency:tree

# Projektinformationen anzeigen
mvn help:effective-pom

# Code-Formatierung
mvn formatter:format

# Lizenz-Header hinzufügen
mvn license:format

Nächste Schritte

Nachdem Sie verstanden haben, wie gebaut und getestet wird, lesen Sie folgende Dokumentation:

Entwicklungsworkflow - Entwicklungsworkflow
Leitfaden für Beiträge - Richtlinien für Beiträge
Architektur und Codestruktur - Verständnis der Codebasis