使用Testcontainers和PostgreSQL进行Quarkus测试

Testcontainers是一个Java库，可轻松将Docker容器集成到JUnit测试中。 在Containerized World中 ，将测试配置与嵌入式数据库和服务复杂化几乎没有意义。 而是使用在Docker中运行您的服务，并让Testcontainers为您管理此服务。 因此，如果您在测试中需要Redis，MongoDB或PostgreSQL – Testcontainer可能会成为您的好朋友。

在此博客文章中，您将学习如何在Quarkus集成测试中配置Testcontainer以管理PostgreSQL实例。

依存关系

为了将Testcontainers与PostgreSQL一起使用，您需要将以下依赖项添加到pom.xml ：

<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>testcontainers</artifactId>
    <version>1.12.5</version>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>org.testcontainers</groupId>
    <artifactId>postgresql</artifactId>
    <version>1.12.5</version>
    <scope>test</scope>
</dependency>

注意：Testcontainers提供了JUnit 5插件，但是在本文介绍的场景中是不需要的。

测试数据源配置

Quarkus应用程序中的默认PostgreSQL配置如下所示：

quarkus.datasource.url=jdbc:postgresql://localhost:5432/some-db
quarkus.datasource.driver=org.postgresql.Driver
quarkus.datasource.username=user
quarkus.datasource.password=password

默认情况下，此配置将在任何活动配置文件中使用。 Quarkus中的内置配置文件是： dev ， prod和test 。 每当您运行@QuarkusTest时，都会使用该test配置文件。

您可以通过提供%test.来调整test配置文件%test. src/main/application.properties文件中配置属性的前缀。 这允许通过JDBC URL方案配置（和启动）PostgreSQL数据库容器。 为此，请确保：

• 将驱动程序设置为org.testcontainers.jdbc.ContainerDatabaseDriver 。 这个特殊的驱动程序可确保在应用程序中需要数据源后即可创建并运行Docker容器，
• 将方言明确设置为org.hibernate.dialect.PostgreSQL9Dialect否则在启动应用程序时会出现异常：

org.junit.jupiter.api.extension.TestInstantiationException: TestInstanceFactory [io.quarkus.test.junit.QuarkusTestExtension] failed to instantiate test class [pl.codeleak.samples.OwnerResourceTest]: io.quarkus.builder.BuildException: Build failure: Build failed due to errors

[错误]

：生成步骤io.quarkus.hibernate.orm.deployment.HibernateOrmProcessor＃build引发了一个异常：io.quarkus.deployment.configuration.ConfigurationError：Hibernate扩展无法从驱动程序org.testcontainers.jdbc.ContainerDatabaseDriver猜得到方言。 添加一个明确的“ quarkus.hibernate-orm.dialect”属性。 在io.quarkus.hibernate.orm.deployment.HibernateOrmProcessor.guessDialect（HibernateOrmProcessor.java:715）

• 将JDBC URL设置为jdbc:tc:postgresql:latest:///dbname以便Testcontainers知道在运行容器时要使用哪个PostgreSQL版本。

完整的配置：

# initializes container for driver initialization
%test.quarkus.datasource.driver=org.testcontainers.jdbc.ContainerDatabaseDriver

# dialect must be set explicitly
%test.quarkus.hibernate-orm.dialect=org.hibernate.dialect.PostgreSQL9Dialect

# Testcontainers JDBC URL
%test.quarkus.datasource.url=jdbc:tc:postgresql:latest:///dbname

使用适当的配置后，您可以运行测试并观察是否已为测试创建了测试容器：

$ ./mvnw clean test

[INFO] -------------------------------------------------------
[INFO]  T E S T S
[INFO] -------------------------------------------------------
[INFO] Running pl.codeleak.samples.OwnerResourceTest
2020-02-27 21:09:21,096 INFO  [io.qua.fly.FlywayProcessor] (build-8) Adding application migrations in path '/Users/rafal.borowiec/Projects/quarkus/quarkus-postgres-sample/target/classes/db/migration' using protocol 'file'
2020-02-27 21:09:23,084 INFO  [org.fly.cor.int.lic.VersionPrinter] (main) Flyway Community Edition 6.1.4 by Redgate
2020-02-27 21:09:23,176 INFO  [org.tes.doc.DockerClientProviderStrategy] (Agroal_1012722761) Loaded org.testcontainers.dockerclient.UnixSocketClientProviderStrategy from ~/.testcontainers.properties, will try it first
2020-02-27 21:09:23,658 INFO  [org.tes.doc.UnixSocketClientProviderStrategy] (Agroal_1012722761) Accessing docker with local Unix socket
2020-02-27 21:09:23,659 INFO  [org.tes.doc.DockerClientProviderStrategy] (Agroal_1012722761) Found Docker environment with local Unix socket (unix:///var/run/docker.sock)
2020-02-27 21:09:23,780 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) Docker host IP address is localhost
2020-02-27 21:09:23,815 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) Connected to docker:
  Server Version: 19.03.2
  API Version: 1.40
  Operating System: Docker Desktop
  Total Memory: 1998 MB
2020-02-27 21:09:23,957 INFO  [org.tes.uti.RegistryAuthLocator] (Agroal_1012722761) Credential helper/store (docker-credential-desktop) does not have credentials for quay.io
2020-02-27 21:09:24,857 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) Ryuk started - will monitor and terminate Testcontainers containers on JVM exit
2020-02-27 21:09:24,857 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) Checking the system...
2020-02-27 21:09:24,858 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) ✔︎ Docker server version should be at least 1.6.0
2020-02-27 21:09:25,040 INFO  [org.tes.DockerClientFactory] (Agroal_1012722761) ✔︎ Docker environment should have more than 2GB free disk space
2020-02-27 21:09:25,078 INFO  [🐳 [postgres:latest]] (Agroal_1012722761) Creating container for image: postgres:latest
2020-02-27 21:09:25,135 INFO  [org.tes.uti.RegistryAuthLocator] (Agroal_1012722761) Credential helper/store (docker-credential-desktop) does not have credentials for index.docker.io
2020-02-27 21:09:25,247 INFO  [🐳 [postgres:latest]] (Agroal_1012722761) Starting container with ID: b436fdabccbe51ba3e6d778d4429505473995d4185a200aef35c4c30b2159369
2020-02-27 21:09:25,779 INFO  [🐳 [postgres:latest]] (Agroal_1012722761) Container postgres:latest is starting: b436fdabccbe51ba3e6d778d4429505473995d4185a200aef35c4c30b2159369
2020-02-27 21:09:26,896 INFO  [🐳 [postgres:latest]] (Agroal_1012722761) Container postgres:latest started in PT3.731519S
2020-02-27 21:09:27,107 INFO  [org.fly.cor.int.dat.DatabaseFactory] (main) Database: jdbc:postgresql://localhost:32830/test (PostgreSQL 12.2)
2020-02-27 21:09:27,146 INFO  [org.fly.cor.int.sch.JdbcTableSchemaHistory] (main) Creating Schema History table "public"."flyway_schema_history" ...
2020-02-27 21:09:27,188 INFO  [org.fly.cor.int.com.DbMigrate] (main) Current version of schema "public": << Empty Schema >>
2020-02-27 21:09:27,193 INFO  [org.fly.cor.int.com.DbMigrate] (main) Migrating schema "public" to version 1.0.0 - Init
2020-02-27 21:09:27,201 INFO  [org.fly.cor.int.sql.DefaultSqlScriptExecutor] (main) DB: table "owners" does not exist, skipping
2020-02-27 21:09:27,226 INFO  [org.fly.cor.int.com.DbMigrate] (main) Successfully applied 1 migration to schema "public" (execution time 00:00.050s)
2020-02-27 21:09:27,726 INFO  [io.quarkus] (main) Quarkus 1.2.1.Final started in 5.761s. Listening on: http://0.0.0.0:8081
2020-02-27 21:09:27,727 INFO  [io.quarkus] (main) Profile test activated.
2020-02-27 21:09:27,727 INFO  [io.quarkus] (main) Installed features: [agroal, cdi, flyway, hibernate-orm, hibernate-orm-panache, hibernate-validator, jdbc-postgresql, narayana-jta, resteasy, resteasy-jackson]
[INFO] Tests run: 10, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 10.091 s - in pl.codeleak.samples.OwnerResourceTest
2020-02-27 21:09:29,975 INFO  [io.quarkus] (main) Quarkus stopped in 0.689s
[INFO]
[INFO] Results:
[INFO]
[INFO] Tests run: 10, Failures: 0, Errors: 0, Skipped: 0
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  15.375 s
[INFO] Finished at: 2020-02-27T21:09:30+01:00
[INFO] ------------------------------------------------------------------------

在此处的官方文档中查看有关数据库配置的更多信息： https : //www.testcontainers.org/modules/databases/

初始化测试数据库

您有几个选项可以初始化数据库。 您可以初始化数据库Flyway ，但你也可以使用Testcontainers到数据库启动后，运行初始化脚本，但之前连接返回的代码。

使用Flyway初始化测试数据库

使用Flyway，可以通过调整%test.方式，仅以测试配置文件的方式调整迁移脚本，就像我们调整数据源的方式一样%test. 配置属性的前缀。 这样，您可以设置不同的迁移文件位置和/或可以为迁移文件配置不同的前缀：

%test.quarkus.flyway.locations=test_db/migration
%test.quarkus.flyway.sql-migration-prefix=test_

使用上述配置，您可能需要创建test/src/resources/test_db/migration并将其放入例如test_1.0.0_schema.sql文件（名称模式为test_version_description.sql ）。

提示：不要忘记将Flyway Quarkus扩展名添加到pom.xml 。

使用Testcontainers初始化测试数据库

如果您不想在测试中使用Flyway，则可以使用Testcontainers加载的脚本来初始化数据库。 可以直接从类路径或从任何位置加载文件。 唯一要做的就是更改JDBC URL：

%test.quarkus.datasource.url=jdbc:tc:postgresql:latest:///dbname?TC_INITSCRIPT=file:src/main/resources/init_pg.sql

要么

%test.quarkus.datasource.url=jdbc:tc:postgresql:latest:///dbname?TC_INITSCRIPT=classpath:init_pg.sql

源代码

可以在Github上找到本文的源代码： https : //github.com/kolorobot/quarkus-postgres-sample （ testcontainers分支）

链接

• 测试容器– https://www.testcontainers.org
• 带有Quarkus的PetClinic REST API – Quarkus 入门–构建PetClinic REST API

翻译自: https://www.javacodegeeks.com/2020/02/quarkus-tests-with-testcontainers-and-postgresql.html