Services surrounding KeyCloak, that use the REST API to read/update state
Project description
keycloak-rest-services
Services surrounding Keycloak, that use the REST API to read/update state.
Running Tests
The tests run automatically in CircleCI, but for those that want to run them locally, there is a way.
First, build and load the local python environment:
./setupenv.sh
. env/bin/activate
Then, start instances of Keycloak, LDAP, and RabbitMQ in other terminals:
./resources/start-keycloak.sh
./resources/start-ldap.sh
./resources/start-rabbitmq.sh
Note that version of Keycloak server used for testing is set in resources/keycloak-image/Dockerfile
.
Keycloak may take a minute to start. If it does not, check your network settings, as it does not play well with VPNs and other more exotic network situations.
Finally, run the tests:
source ./resources/pytest-env.sh
pytest
Getting Test Coverage
If you want a coverage report, instead of running pytest directly, run it under the coverage tool:
keycloak_url=http://localhost:8080 username=admin password=admin coverage run -m pytest
coverage html --include='krs*'
Manually Running Scripts
It is possible to manually run all of the basic operations for controlling users and groups.
-
Bootstrap Keycloak
If you do not already have a Keycloak instance, start a test instance as shown above. Then, run the bootstrap script to create a realm and the REST service account:
keycloak_url=http://localhost:8080 username=admin password=admin realm=test python3 -m krs.bootstrap
Save the
client_secret
that gets printed, as you will need this. -
User and group actions
Now you can actually run the scripts, which take the format:
keycloak_url=http://localhost:8080 client_id=rest-access client_secret=<SECRET> realm=test python -m krs.<SCRIPT> <ARGS>
As an example, to list all groups:
keycloak_url=http://localhost:8080 client_id=rest-access client_secret=<SECRET> realm=test python -m krs.groups list
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for wipac-keycloak-rest-services-1.4.89.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e33e9a505106bb5d7fe49fd1f96d6fa7422106832bb46312c811413f56fe03f4 |
|
MD5 | eac1d90516f4f7f61d2032d4ca8d85f1 |
|
BLAKE2b-256 | c53c2cf46fe4f2a9f25cefa261f37a89e3be3c11116400d2fdcc873525f6482b |
Hashes for wipac_keycloak_rest_services-1.4.89-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c87c056feed164b1d558fbc112806f9a5832ab8a5b46f63a6c5afc490a988119 |
|
MD5 | efbab171b5c4fa9cda557f5033e725bd |
|
BLAKE2b-256 | c9cd2b1bcd5c7e063e67243abbf2e2da8f066c98a1308d67848c0bcda196c953 |