86 lines
3.4 KiB
Markdown
86 lines
3.4 KiB
Markdown
Test with various databases
|
|
===========================
|
|
|
|
MySQL
|
|
-----
|
|
|
|
The simplest way to test with MySQL is to use the official [MySQL docker image](https://registry.hub.docker.com/_/mysql/).
|
|
|
|
Start MySQL:
|
|
|
|
docker run --name mysql -e MYSQL_DATABASE=keycloak -e MYSQL_USER=keycloak -e MYSQL_PASSWORD=keycloak -e MYSQL_ROOT_PASSWORD=keycloak -d mysql
|
|
|
|
Run tests:
|
|
|
|
mvn install -Dkeycloak.connectionsJpa.url=jdbc:mysql://`docker inspect --format '{{ .NetworkSettings.IPAddress }}' mysql`/keycloak -Dkeycloak.connectionsJpa.driver=com.mysql.jdbc.Driver -Dkeycloak.connectionsJpa.user=keycloak -Dkeycloak.connectionsJpa.password=keycloak
|
|
|
|
Stop MySQl:
|
|
|
|
docker rm -f mysql
|
|
|
|
|
|
PostgreSQL
|
|
----------
|
|
|
|
The simplest way to test with PostgreSQL is to use the official [PostgreSQL docker image](https://registry.hub.docker.com/_/postgres/).
|
|
|
|
Start PostgreSQL:
|
|
|
|
docker run --name postgres -e POSTGRES_DATABASE=keycloak -e POSTGRES_USER=keycloak -e POSTGRES_PASSWORD=keycloak -e POSTGRES_ROOT_PASSWORD=keycloak -d postgres
|
|
|
|
Run tests:
|
|
|
|
mvn install -Dkeycloak.connectionsJpa.url=jdbc:postgresql://`docker inspect --format '{{ .NetworkSettings.IPAddress }}' postgres`:5432/keycloak -Dkeycloak.connectionsJpa.driver=org.postgresql.Driver -Dkeycloak.connectionsJpa.user=keycloak -Dkeycloak.connectionsJpa.password=keycloak
|
|
|
|
Stop PostgreSQL:
|
|
|
|
docker rm -f postgres
|
|
|
|
MariaDB
|
|
-------
|
|
|
|
The simplest way to test with MariaDB is to use the official [MariaDB docker image](https://registry.hub.docker.com/_/mariadb/).
|
|
|
|
Start MariaDB:
|
|
|
|
docker run --name mariadb -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=keycloak -e MYSQL_USER=keycloak -e MYSQL_PASSWORD=keycloak -d mariadb:10.1
|
|
|
|
Run tests:
|
|
|
|
mvn install -Dkeycloak.connectionsJpa.url=jdbc:mariadb://`docker inspect --format '{{ .NetworkSettings.IPAddress }}' mariadb`/keycloak -Dkeycloak.connectionsJpa.driver=org.mariadb.jdbc.Driver -Dkeycloak.connectionsJpa.user=keycloak -Dkeycloak.connectionsJpa.password=keycloak
|
|
|
|
Stop MySQl:
|
|
|
|
docker rm -f mariadb
|
|
|
|
Using built-in profiles to run database tests using docker containers
|
|
-------
|
|
|
|
The project provides specific profiles to run database tests using containers. Below is a just a sample of implemented profiles. In order to get a full list, please invoke (`mvn help:all-profiles -pl testsuite/integration-arquillian | grep -- db-`):
|
|
|
|
* `db-mysql`
|
|
* `db-postgres`
|
|
|
|
As an example, to run tests using a MySQL docker container on Undertow auth-server:
|
|
|
|
mvn -f testsuite/integration-arquillian clean verify -Pdb-mysql
|
|
|
|
If you want to run tests using a pre-configured Keycloak distribution (instead of Undertow):
|
|
|
|
mvn -f testsuite/integration-arquillian clean verify -Pdb-mysql,jpa,auth-server-quarkus
|
|
|
|
Note that you must always activate the `jpa` profile when using auth-server-quarkus.
|
|
|
|
If the mvn command fails for any reason, it may also fail to remove the container which
|
|
must be then removed manually.
|
|
|
|
For Oracle databases, the images are not publicly available due to licensing restrictions.
|
|
|
|
Build the Docker image per instructions at
|
|
https://github.com/oracle/docker-images/tree/main/OracleDatabase.
|
|
Update the property `docker.database.image` if you used a different
|
|
name or tag for the image.
|
|
|
|
Note that Docker containers may occupy some space even after termination, and
|
|
especially with databases that might be easily a gigabyte. It is thus
|
|
advisable to run `docker system prune` occasionally to reclaim that space.
|