-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moving docs to Antora so it can be linked and search in a simpler way
- Loading branch information
Showing
4 changed files
with
42 additions
and
35 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
= Cross-DC Functional Testing | ||
:description: Validate the Cross Data Center functionality of Keycloak in an actual cross data center setup for Keycloak application. | ||
|
||
{description} | ||
As part of that, we created a test suite currently hosted in the link:{github-files}/provision/rosa-cross-dc/keycloak-benchmark-crossdc-tests/[keycloak-benchmark-crossdc-tests]. | ||
|
||
== CrossDC Test Framework | ||
|
||
The current framework is made up of the below components: | ||
|
||
Testsuite root directory:: keycloak-benchmark/provision/rosa-cross-dc | ||
Test Runner:: JUnit5. | ||
Test Data:: Use xref:dataset-guide::index.adoc[Dataset Provider]. | ||
Cache Metrics:: https://infinispan.org/docs/stable/titles/rest/rest.html[ISPN Http REST client] to access Cache stats for external ISPN server. | ||
And for the embedded Infinispan cache, we are relying on the xref:dataset-guide::index.adoc[Dataset Provider]. | ||
Execution Target:: A CrossDC cluster with access to two Keycloak and Infinispan datacenter URLs. | ||
|
||
NOTE: We will use the existing ROSA OCP cluster based deployment during development to bring up the cross-dc cluster. | ||
|
||
== How to run | ||
|
||
From the Testsuite root directory run the below command to run the tests | ||
|
||
---- | ||
mvn clean install -DcrossDCTests \ | ||
-Dinfinispan.dc1.url=<ISPN_DC1_URL> -Dkeycloak.dc1.url=<KEYCLOAK_DC1_URL> \ | ||
-Dinfinispan.dc2.url=<ISPN_DC2_URL> -Dkeycloak.dc2.url=<KEYCLOAK_DC2_URL> \ | ||
-Dinfinispan.password=<ISPN_PASSWORD> | ||
---- | ||
|
||
Alternatively could use the `run-crossdc-tests.sh` (located in the Testsuite root) directory to execute the tests when using a ROSA style provisioning setup to fetch the `ISPN_PASSWORD` on the fly, or by setting it manually. | ||
|
||
Example usage: | ||
|
||
---- | ||
ISPN_DC1_URL=<ISPN_DC1_URL> ISPN_DC2_URL=<ISPN_DC2_URL> \ | ||
KEYCLOAK_DC1_URL=<KEYCLOAK_DC1_URL> KEYCLOAK_DC2_URL=<KEYCLOAK_DC2_URL> \ | ||
./run-crossdc-tests.sh | ||
---- |
2 changes: 2 additions & 0 deletions
2
provision/rosa-cross-dc/keycloak-benchmark-crossdc-tests/README.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
See https://www.keycloak.org/keycloak-benchmark/kubernetes-guide/latest/testing/[Cross-DC Functional Testing | ||
] on how to use this Taskfile. |
35 changes: 0 additions & 35 deletions
35
provision/rosa-cross-dc/keycloak-benchmark-crossdc-tests/README.md
This file was deleted.
Oops, something went wrong.