mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
93209bd348
# Which Problems Are Solved Outdated deps on the benchmark typscript modules. # How the Problems Are Solved Upgrade all deps # Additional Changes - Add xk6 a prerequisite for running benchmarks - Update the moduleResolution setting in tsconfig to a non-deprecated value - Some automatic code formatting --------- Co-authored-by: Copilot Autofix powered by AI <[email protected]>
81 lines
4.1 KiB
Markdown
81 lines
4.1 KiB
Markdown
# Benchmarks
|
|
|
|
This package contains code for benchmarking specific endpoints of the API using [k6](https://k6.io).
|
|
|
|
## Prerequisite
|
|
|
|
* [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
|
|
* [k6](https://k6.io/docs/get-started/installation/)
|
|
* [go](https://go.dev/doc/install)
|
|
* [xk6](https://github.com/grafana/xk6#local-installation) (make sure `~/go/bin` is in your `${PATH}`)
|
|
* running the API
|
|
|
|
## Structure
|
|
|
|
The use cases under tests are defined in `src/use_cases`. The implementation of ZITADEL resources and calls are located under `src`.
|
|
|
|
## Execution
|
|
|
|
### Env vars
|
|
|
|
* `VUS`: Amount of parallel processes execute the test (default is 20)
|
|
* `DURATION`: Defines how long the tests are executed (default is `200s`)
|
|
* `ZITADEL_HOST`: URL of ZITADEL (default is `http://localhost:8080`)
|
|
* `ADMIN_LOGIN_NAME`: Loginanme of a human user with `IAM_OWNER`-role
|
|
* `ADMIN_PASSWORD`: password of the human user
|
|
|
|
To setup the tests we use the credentials of management console and log in using an admin. The user must be able to create organizations and all resources inside organizations.
|
|
|
|
* `ADMIN_LOGIN_NAME`: `[email protected]`
|
|
* `ADMIN_PASSWORD`: `Password1!`
|
|
|
|
### Test
|
|
|
|
Before you run the tests you need an initialized user. The tests don't implement the change password screen during login.
|
|
|
|
* `make human_password_login`
|
|
setup: creates human users
|
|
test: uses the previously created humans to sign in using the login ui
|
|
* `make machine_pat_login`
|
|
setup: creates machines and a pat for each machine
|
|
test: calls user info endpoint with the given pats
|
|
* `make machine_client_credentials_login`
|
|
setup: creates machines and a client credential secret for each machine
|
|
test: calls token endpoint with the `client_credentials` grant type.
|
|
* `make user_info`
|
|
setup: creates human users and signs them in
|
|
test: calls user info endpoint using the given humans
|
|
* `make manipulate_user`
|
|
test: creates a human, updates its profile, locks the user and then deletes it
|
|
* `make introspect`
|
|
setup: creates projects, one api per project, one key per api and generates the jwt from the given keys
|
|
test: calls introspection endpoint using the given JWTs
|
|
* `make add_session`
|
|
setup: creates human users
|
|
test: creates new sessions with user id check
|
|
* `make oidc_session`
|
|
setup: creates a service account to create the auth request and session.
|
|
test: creates an auth request, a session and links the session to the auth request. Implementation of [this flow](https://zitadel.com/docs/guides/integrate/login-ui/oidc-standard).
|
|
* `make otp_session`
|
|
setup: creates 1 human user for each VU and adds OTP Email to it
|
|
test: creates a session based on the login name of the user, sets the OTP Email challenge to the session and afterwards checks the OTP code
|
|
* `make password_session`
|
|
setup: creates 1 human user for each VU and adds OTP Email to it
|
|
test: creates a session based on the login name of the user and checks for the password on a second step
|
|
* `make machine_jwt_profile_grant`
|
|
setup: generates private/public key, creates service accounts, adds a key
|
|
test: creates a token and calls user info
|
|
* `make machine_jwt_profile_grant_single_user`
|
|
setup: generates private/public key, creates service account, adds a key
|
|
test: creates a token and calls user info in parallel for the same user
|
|
* `make users_by_metadata_key`
|
|
setup: creates for half of the VUS a human user and a machine for the other half, adds 3 metadata to each user
|
|
test: calls the list users endpoint and filters by a metadata key
|
|
* `make users_by_metadata_value`
|
|
setup: creates for half of the VUS a human user and a machine for the other half, adds 3 metadata to each user
|
|
test: calls the list users endpoint and filters by a metadata value
|
|
* `make verify_all_user_grants_exists`
|
|
setup: creates 50 projects, 1 machine per VU
|
|
test: creates a machine and grants all projects to the machine
|
|
teardown: the organization is not removed to verify the data of the projections are correct. You can find additional information [at the bottom of this file](./src/use_cases/verify_all_user_grants_exist.ts)
|