Řešení problémů s testy Quarkus, testovacími kontejnery a integrací Liquibase

Zajištění správné integrace mezi Liquibase a TestContainers v Quarkusu

Backendové řešení využívající Quarkus s TestContainers ke správě migrací PostgreSQL a Liquibase. Tento skript řeší problémy s nesprávným zarovnáním kontejneru.

import org.testcontainers.containers.PostgreSQLContainer;
import org.testcontainers.utility.DockerImageName;
import java.util.HashMap;
import java.util.Map;
public class PostgreSQLTestResource implements QuarkusTestResourceLifecycleManager {
    private static PostgreSQLContainer<?> postgreSQLContainer;
    @Override
    public Map<String, String> start() {
        postgreSQLContainer = new PostgreSQLContainer<>(DockerImageName.parse("postgres:alpine"))
            .withDatabaseName("test")
            .withUsername("postgres")
            .withPassword("password")
            .withReuse(true);
        postgreSQLContainer.start();
        Map<String, String> config = new HashMap<>();
        config.put("quarkus.datasource.jdbc.url", postgreSQLContainer.getJdbcUrl());
        config.put("quarkus.datasource.username", postgreSQLContainer.getUsername());
        config.put("quarkus.datasource.password", postgreSQLContainer.getPassword());
        return config;
    }
    @Override
    public void stop() {
        if (postgreSQLContainer != null) {
            postgreSQLContainer.stop();
        }
    }
}

Ověřování integrace aplikace-Liquibase pomocí testů jednotek

Modulární a opakovaně použitelný testovací příklad Quarkus, který ověřuje připojení k databázi a spuštění skriptu migrace.

import org.junit.jupiter.api.Test;
import io.quarkus.test.junit.QuarkusTest;
import io.quarkus.test.junit.TestProfile;
@QuarkusTest
@TestProfile(TestProfileResolver.class)
public class XServiceTest {
    @Inject
    XTypeVersionService xTypeVersionService;
    @Test
    public void getXTypeVersion() {
        List<XTypeVersionEntity> entities = xTypeVersionService.get();
        assertFalse(entities.isEmpty(), "The entity list should not be empty.");
    }
}

Zajištění konzistence konfigurace napříč testovacími profily

Vlastní konfigurace testovacího profilu pro zajištění souladu mezi Liquibase a aplikačními kontejnery.

public class TestProfileResolver implements QuarkusTestProfile {
    @Override
    public String getConfigProfile() {
        return "test";
    }
    @Override
    public Map<String, String> getConfigOverrides() {
        return Map.of("quarkus.config.locations", "src/test/resources/application.yaml");
    }
}

Simulace front-endu pro ověření dat

Dynamický front-endový fragment kódu pro zajištění správného zobrazení dat z integrace databáze.

fetch('/api/xTypeVersion')
    .then(response => response.json())
    .then(data => {
        const list = document.getElementById('entity-list');
        data.forEach(entity => {
            const item = document.createElement('li');
            item.textContent = entity.name;
            list.appendChild(item);
        });
    })
    .catch(error => console.error('Error fetching data:', error));

Unit Testy pro backend a front-end konzistenci

Ukázkové testovací skripty pro ověření jak back-endové logiky, tak front-endové integrace s testovacími daty.

import org.junit.jupiter.api.Test;
public class FrontEndValidationTest {
    @Test
    public void fetchData() {
        given().when().get("/api/xTypeVersion")
            .then().statusCode(200)
            .body("size()", greaterThan(0));
    }
}

Časté otázky o Quarkus, TestContainers a integraci Liquibase

1. Jaká je role TestContainers v integračních testech?
2. TestContainers pomáhá spravovat izolované instance databáze během testování a zajišťuje konzistentní prostředí.
3. Proč potřebuji withReuse(true) příkaz?
4. The withReuse(true) umožňuje znovu použít stejný kontejner ve více testech, což šetří prostředky a čas nastavení.
5. Jaký je účel TC_INITSCRIPT vlastnictví?
6. The TC_INITSCRIPT vlastnost určuje inicializační SQL skript, který založí databázi při spuštění kontejneru.
7. Jak zajistím, aby migrace Liquibase byly aplikovány správně?
8. Nakonfigurováním quarkus.liquibase.jdbc.url vlastnost, můžete zajistit, že Liquibase používá stejný databázový kontejner jako aplikace.
9. Jaké úrovně protokolu bych měl použít pro ladění?
10. Soubor TRACE nebo DEBUG úrovně pro Liquibase a TestContainers pro monitorování databázových operací a migrací.
11. Jak mohu testovat odpovědi API s nasazenými daty?
12. Používejte nástroje jako RestAssured odesílat požadavky na koncové body a ověřovat, že vrácená data odpovídají testovacím datům.
13. Co dělá @QuarkusTestResource anotace udělat?
14. The @QuarkusTestResource anotace registruje vlastního správce životního cyklu pro externí závislosti, jako jsou databáze.
15. Proč potřebuji vlastní TestProfileResolver?
16. Zajišťuje načtení správných konfigurací pro provedení testu, zarovnání proměnných prostředí a zdrojů.
17. Jak zjistím, zda se vytváří více kontejnerů?
18. Zkontrolujte svůj Docker Desktop nebo sledujte protokoly konzoly, zda neobsahují duplicitní instance kontejnerů a jejich příslušné porty.
19. Jaký je nejlepší způsob, jak vyčistit testovací zdroje?
20. Přepsat stop metodu ve správci životního cyklu k zastavení a odstranění kontejneru po dokončení testů.

Klíčové poznatky pro řešení konfliktů při testování

Testování integrace s Quarkus, Liquibase a TestContainers vyžaduje pečlivé nastavení, aby bylo zajištěno, že migrace a interakce s databází budou v souladu. Přizpůsobením správce testovacích prostředků a používáním jednotné konfigurace můžete eliminovat konflikty mezi kontejnery používanými Liquibase a vaší aplikací.

Tyto kroky vám pomohou zefektivnit proces testování a usnadnit ladění a ověřování testů. Nezapomeňte použít podrobné protokoly, jako je povolení STOPA pro Liquibase, abyste mohli sledovat chování vašich testů a včas vyřešit nesrovnalosti. S tímto přístupem můžete s jistotou vytvářet škálovatelné a udržovatelné testy. 🐛