https://github.com/mdgreenfield/microsoft-graph-api-reliability

Test the reliability of Microsoft Graph API
https://github.com/mdgreenfield/microsoft-graph-api-reliability

azure graph-api microsoft microsoft-graph-api reliability

Last synced: about 1 month ago
JSON representation

Test the reliability of Microsoft Graph API

• Host: GitHub
• URL: https://github.com/mdgreenfield/microsoft-graph-api-reliability
• Owner: mdgreenfield
• Created: 2021-03-12T18:20:19.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2021-03-12T18:58:39.000Z (almost 4 years ago)
• Last Synced: 2024-01-29T20:57:40.336Z (11 months ago)
• Topics: azure, graph-api, microsoft, microsoft-graph-api, reliability
• Language: Go
• Homepage:
• Size: 5.86 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# microsoft-graph-api-reliability

Exercises the Microsoft Graph API v1.0 to ensure Application passwords are reliably persisted.

This test issues parallel requests to the MS Graph API [addPassword endpoint](https://docs.microsoft.com/en-us/graph/api/application-addpassword?view=graph-rest-1.0&tabs=http) in parallel and ensures that every successful password created is persisted by Azure.

To run this test the following environment variables MUST be set:

- `TENANT_ID` - The Azure tenant

- `SUBSCRIPTION_ID` - The Azure subscription

- `CLIENT_ID` - The application (client) ID. Note the permission requirements below.

- `CLIENT_SECRET` - The application password

- `SUT_APPLICATION_OBJECT_ID` - The Subject Under Test application object ID (i.e. the application for which passwords will be added)

Optionally, the following can be set:

- `RETRY_ATTEMPTS` - Specifies the number of HTTP retry attempts for each request. Defaults to 3 per the `Azure/go-autorest` library.

- `PARALLEL_REQUESTS` - The number of parallel `addPassword` requests to send to MS Graph API. Defaults to 20.

The [MS Graph API docs](https://docs.microsoft.com/en-us/graph/api/application-addpassword?view=graph-rest-1.0&tabs=http#permissions) highlight the possible API Permissions that can be used for the application which is creating the passwords. `Application.ReadWrite.All` will suffice. Be sure to grant consent to the permission on the application.

## Run the Test

Set your environments variables (see above) and then call `make test`.

## Currently Observed Behavior

- Frequently, especially with larger numbers (i.e. > 10) of parallel requests to `addPassword`, a response reports successful password creation, however, that password is not associated with the application when reading back all the password credentials.

- At greater than ~5 parallel requests we see responses slow down significantly.

- At greater than ~15 parallel requests we start seeing HTTP 503 responses. The `go-autorest` automatically handles retries, the default is 3. Setting the retry count to 0 makes this problem even more apparent even at ~5 parallel requests.

- In rare instances an HTTP 500 has been returned.