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_secretthat 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
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.80.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 32cec1c4d94ac038faeab44c020b54d84832601fe8f525ef1509c9d72f0124b6 |
|
| MD5 | 3fc40fb6b1550e903fdbb14516998a40 |
|
| BLAKE2b-256 | eace4d23dbdb60c4568f210bf653c78a6a9935e9a4d7aef8defb4fcc278bd2db |
Hashes for wipac_keycloak_rest_services-1.4.80-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f911ea521d5f7e3f6ee4d5eec77965d19f01644fd190dfe08ce087b73824290 |
|
| MD5 | 1ed8aff2af6ed81c425f310cc2764c4b |
|
| BLAKE2b-256 | a7ba0c77e51171e1b0b4e50d86aae4dbb9386010dc8b7156576ca79b0af78bcb |
