3.5. 测试
当测试涉及向独立的 OIDC 服务器进行身份验证时,测试通常很复杂。Quarkus 提供多个选项,从模拟到 OIDC 供应商的本地运行。
首先,将以下依赖项添加到 test 项目中:
使用 Maven:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用 Gradle:
testImplementation("net.sourceforge.htmlunit:htmlunit") testImplementation("io.quarkus:quarkus-junit5")
testImplementation("net.sourceforge.htmlunit:htmlunit") testImplementation("io.quarkus:quarkus-junit5")
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
3.5.1. Wiremock 复制链接链接已复制到粘贴板!
添加以下依赖项:
使用 Maven:
<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-test-oidc-server</artifactId> <scope>test</scope> </dependency>
<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-test-oidc-server</artifactId> <scope>test</scope> </dependency>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用 Gradle:
testImplementation("io.quarkus:quarkus-test-oidc-server")
testImplementation("io.quarkus:quarkus-test-oidc-server")
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
准备 REST 测试端点并设置 application.properties
。例如:
keycloak.url is set by OidcWiremockTestResource
# keycloak.url is set by OidcWiremockTestResource
quarkus.oidc.auth-server-url=${keycloak.url}/realms/quarkus/
quarkus.oidc.client-id=quarkus-web-app
quarkus.oidc.credentials.secret=secret
quarkus.oidc.application-type=web-app
最后,编写测试代码,例如:
OidcWiremockTestResource
可识别 alice
和 admin
用户。用户 alice
默认具有用户角色 - 它可以通过 quarkus.test.oidc.token.
系统属性进行自定义。用户 user
-rolesadmin
默认具有 用户和
admin
角色 - 它可以通过 quarkus.test.oidc.token.admin-roles
系统属性进行自定义。
另外,OidcWiremockTestResource
将令牌签发者和 audience 设置为 https://service.example.com
,它可以通过 quarkus.test.oidc.token.issuer
和 quarkus.test.oidc.token.audience
系统属性进行自定义。
OidcWiremockTestResource
可用于模拟所有 OIDC 供应商。
3.5.2. Keycloak 的 dev Services 复制链接链接已复制到粘贴板!
建议对 Keycloak 使用 Dev Services 进行 集成测试。用于 Keycloak 的 dev Services
将启动并初始化测试容器:它将创建一个 quarkus
域、quarkus-app
客户端(secret
secret),并添加 alice
(admin
和
roles)和 user
bob
(用户角色)用户,您可以在其中自定义所有这些属性。
首先,准备 application.properties
。您可以从完全空的 application.properties
文件作为 Keycloak 的 Dev Services
开始,注册指向正在运行的测试容器的 quarkus.oidc.auth-server-url
,以及 quarkus.oidc.client-id=quarkus-app
和 quarkus.oidc.credentials.secret=secret
。
但是,如果您已经配置了所有必需的 quarkus-oidc
属性,则您只需要将 quarkus.oidc.auth-server-url
与 Keycloak 的 Dev Services 的
prod
配置集关联,才能启动容器。例如:
%prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus
%prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus
如果在运行测试前必须将自定义域文件导入到 Keycloak 中,您可以为 Keycloak 配置 Dev Services
,如下所示:
%prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus quarkus.keycloak.devservices.realm-path=quarkus-realm.json
%prod.quarkus.oidc.auth-server-url=http://localhost:8180/realms/quarkus
quarkus.keycloak.devservices.realm-path=quarkus-realm.json
最后,按照与 Wiremock 部分相同的方式编写测试代码。唯一的区别是 @QuarkusTestResource
不再需要:
@QuarkusTest public class CodeFlowAuthorizationTest { }
@QuarkusTest
public class CodeFlowAuthorizationTest {
}
3.5.3. TestSecurity 注解 复制链接链接已复制到粘贴板!
您可以使用 @TestSecurity 和 @OidcSecurity 注释来测试 web-app
应用端点代码,这取决于以下注入之一,或者全部四个:
-
ID
JsonWebToken
-
Access
JsonWebToken
-
UserInfo
-
OidcConfigurationMetadata
有关更多信息,请参阅将 TestingSecurity 与注入的 JsonWebToken 搭配使用。
3.5.4. 检查日志中的错误 复制链接链接已复制到粘贴板!
要查看有关令牌验证错误的详情,您必须启用 io.quarkus.oidc.runtime.OidcProvider
TRACE
级别日志记录:
quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".level=TRACE quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".min-level=TRACE
quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".level=TRACE
quarkus.log.category."io.quarkus.oidc.runtime.OidcProvider".min-level=TRACE
要查看有关 OidcProvider 客户端初始化错误的详细信息,请启用 io.quarkus.oidc.runtime.OidcRecorder
TRACE
级别日志记录:
quarkus.log.category."io.quarkus.oidc.runtime.OidcRecorder".level=TRACE quarkus.log.category."io.quarkus.oidc.runtime.OidcRecorder".min-level=TRACE
quarkus.log.category."io.quarkus.oidc.runtime.OidcRecorder".level=TRACE
quarkus.log.category."io.quarkus.oidc.runtime.OidcRecorder".min-level=TRACE
从 quarkus dev
控制台,键入 j
以更改应用全局日志级别。