Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TNG/keycloak-mock
A Java library to test REST endpoints secured by Keycloak via OpenID connect.
https://github.com/TNG/keycloak-mock
keycloak mock single-sign-on testing
Last synced: about 1 month ago
JSON representation
A Java library to test REST endpoints secured by Keycloak via OpenID connect.
- Host: GitHub
- URL: https://github.com/TNG/keycloak-mock
- Owner: TNG
- License: apache-2.0
- Created: 2019-10-07T08:26:37.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T01:17:55.000Z (about 2 months ago)
- Last Synced: 2024-05-02T17:19:43.893Z (about 2 months ago)
- Topics: keycloak, mock, single-sign-on, testing
- Language: Java
- Homepage:
- Size: 3.76 MB
- Stars: 110
- Watchers: 17
- Forks: 27
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Lists
- awesome-keycloak - Keycloak Mock Library
README
[](https://github.com/TNG/keycloak-mock/actions?query=branch%3Amain)
[
](https://github.com/TNG/keycloak-mock/releases)
[](https://search.maven.org/search?q=com.tngtech.keycloakmock)
[](https://sonarcloud.io/dashboard?id=TNG_keycloak-mock)
# Keycloak Mock
[Keycloak](https://www.keycloak.org) is a single sign-on solution that supports the
[Open ID connect](https://openid.net/connect/) standard. However, it does not deliver any test
support. This library is intended to fill that gap.
## Recent changes
Have a look at our [release notes](https://github.com/TNG/keycloak-mock/releases) for recent
releases and changes.
## Usage
All artifacts are available on [Maven Central Repository](https://search.maven.org/) under the group
ID `com.tngtech.keycloakmock`.
### Testing authenticated backend calls
When testing a REST backend that is protected by a Keycloak adapter, the mock allows to generate
valid access tokens with configurable content (e.g. roles).
You can create and start the mock directly from the `mock` artifact using Maven
```maven
com.tngtech.keycloakmock
mock
test
0.16.0
```
or Gradle
```gradle
testImplementation 'com.tngtech.keycloakmock:mock:0.16.0'
```
like this:
```java
import static com.tngtech.keycloakmock.api.ServerConfig.aServerConfig;
import com.tngtech.keycloakmock.api.KeycloakMock;
class Test {
void checkSomething() {
KeycloakMock mock = new KeycloakMock(aServerConfig().withPort(8000).withDefaultRealm("master").build());
mock.start();
// do your test stuff
mock.stop();
}
void quarkusKeycloakMocks() {
// to mock Keycloak without context path (v18.0.0+)
KeycloakMock mockNoContextPath = new KeycloakMock(aServerConfig().withNoContextPath().build());
// or to use custom one
KeycloakMock mockCustomContextPath = new KeycloakMock(aServerConfig().withContextPath("/context-path").build());
// if context path is not provided, '/auth' will be used as default due to backward compatibility reasons
KeycloakMock mockDefaultContextPath = new KeycloakMock(aServerConfig().build());
// ...
}
}
```
You can also use the convenience wrapper `mock-junit` for JUnit4
```java
import com.tngtech.keycloakmock.junit.KeycloakMockRule;
public class Test {
@ClassRule
public static KeycloakMockRule mock = new KeycloakMockRule();
// ...
}
```
or `mock-junit5` for JUnit5
```java
import com.tngtech.keycloakmock.junit5.KeycloakMockExtension;
class Test {
@RegisterExtension
static KeycloakMockExtension mock = new KeycloakMockExtension();
// ...
}
```
to let JUnit start the mock for you.
You can then generate a token of your choosing by providing a TokenConfig:
```java
import static com.tngtech.keycloakmock.api.TokenConfig.aTokenConfig;
class Test {
String accessToken = mock.getAccessToken(aTokenConfig().withRole("ROLE_ADMIN").build());
// ...
}
```
For a more in-detail test case, please have a look at
the [AuthenticationTest](example-backend/src/test/java/com/tngtech/keycloakmock/examplebackend/AuthenticationTest.java)
in our example backend project.
In addition to generating and signing tokens programmatically, the mock also offers
* user login (using implicit or authorization code flow, including support for redirect
to `http://localhost` and `urn:ietf:wg:oauth:2.0:oob` for desktop applications)
** instead of a password, you can enter the roles of the user
* client credentials authentication
* resource owner password credentials authentication (both for public and confidential clients)
Note that as this is a mock, all flows are allowed for any client. For simplicity all successful
calls to the token endpoint return the same response including a refresh token, even for flows which
should not contain it according to the specifications.
### Developing / testing frontends
It is also possible to run the mock server as a stand-alone application. Just get the (
self-contained)
`standalone` artifact, e.g.
from [Maven Central](https://search.maven.org/artifact/com.tngtech.keycloakmock/standalone), and run
it:
```bash
$ java -jar standalone.jar &
[main] INFO com.tngtech.keycloakmock.standalone.Main - Server is running on http://localhost:8000
```
The stand-alone server can be configured using command line parameters. You can call it
with `--help` to get a list of all options.
You can even use it as a replacement in end-to-end tests, as the server is e.g. compatible with
`cypress-keycloak`. Have a look at the [example-frontend-react](example-frontend-react) project on
this can be set up.
## License
This project is licensed under the Apache 2.0 license (see [LICENSE](LICENSE)).