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.87.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 95659a0c6a5b907d9cbe41507810ee1e384a5620dee54c75950f1c4f8c3955ed |
|
MD5 | 85405638bdc0a74a226e17cef5e33272 |
|
BLAKE2b-256 | 135900b30e543657af14c4cf153e3d263f6dc24be046b216f70b026e9f623159 |
Hashes for wipac_keycloak_rest_services-1.4.87-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bca57d280766d851411500d3e3a562869a451d6f313caa6c25b5bb995c41dc7c |
|
MD5 | 4e08bdf0d7927cb01819154d9a283b9c |
|
BLAKE2b-256 | d48271af8ebce088d5a42b3a1999e2b55eb8dd7d0a262efe997cbf3060a589fe |