1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
# azure-keyvault-keys Performance Tests
In order to run the performance tests, the `devtools_testutils` package must be installed. This is done as part of the
`dev_requirements` install. Start by creating a new virtual environment for your perf tests. This will need to be a
Python 3 environment, preferably >=3.7.
### Setup for test resources
The following environment variables will need to be set for the tests to access the live resources:
```
AZURE_TENANT_ID=<tenant ID of testing service principal>
AZURE_CLIENT_ID=<client ID of testing service principal>
AZURE_CLIENT_SECRET=<client secret of testing service principal>
AZURE_KEYVAULT_URL=<URL of the testing key vault>
```
### Setup for perf test runs
```cmd
(env) ~/azure-keyvault-keys> pip install -r dev_requirements.txt
(env) ~/azure-keyvault-keys> pip install -e .
```
## Test commands
Once `devtools_testutils` is installed, you will have access to the `perfstress` command line tool, which will scan the
current module for runnable perf tests. Only a specific test can be run at a time (i.e. there is no "run all" feature).
```cmd
(env) ~/azure-keyvault-keys> cd tests/perfstress_tests/
(env) ~/azure-keyvault-keys/tests> perfstress
```
Using the `perfstress` command alone will list the available perf tests found.
### Common perf command line options
These options are available for all perf tests:
- `--duration=10` Number of seconds to run as many operations (the "run" function) as possible. Default is 10.
- `--iterations=1` Number of test iterations to run. Default is 1.
- `--parallel=1` Number of tests to run in parallel. Default is 1.
- `--warm-up=5` Number of seconds to spend warming up the connection before measuring begins. Default is 5.
- `--sync` Whether to run the tests in sync or async. Default is False (async).
- `--no-cleanup` Whether to keep newly created resources after test run. Default is False (resources will be deleted).
## Example command
```cmd
(env) ~/azure-keyvault-keys/tests> perfstress GetKeyTest
```
|
