keycloak/test-framework/docs

Keycloak Test Framework

The Keycloak JUnit test framework makes it easy to write tests for Keycloak and extensions. Behind the scenes the framework handles the lifecycle of Keycloak, the database, and any injected resources such as realms and clients.

Tests simply declare what they want, including specific configuration, and the framework takes care of the rest.

Chapters

• Getting started - Quick start for using the test framework
• Configuring - Overview of how to configure the test framework
• Writing tests - How to write tests
• Running tests - How to run tests using different configuration options
• Configuring logging - How to configure logging when running tests
• Using test suites - How to use tests suites with custom configuration
• Best practices - Best practices and common pitfalls
• Debugging - Debugging Keycloak and extensions
• Writing extensions - Writing test framework extensions
• GitHub Actions - Support for creating job summary on GitHub Actions