You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-26Lines changed: 26 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Microsoft Graph Chaos Proxy
1
+
# Microsoft Graph Developer Proxy
2
2
3
3
**Build with Microsoft Graph. Reliably**
4
4
5
-
Microsoft Graph Chaos Proxy allows you to verify that your application, that uses Microsoft Graph, correctly handles errors that can happen when the application is used at scale. With Graph Chaos Proxy you can:
5
+
Microsoft Graph Developer Proxy allows you to verify that your application, that uses Microsoft Graph, correctly handles errors that can happen when the application is used at scale. With Graph Developer Proxy you can:
6
6
7
7
-**simulate Microsoft Graph API errors**, to verify that your application handles them gracefully when deployed at scale,
8
8
-**mock Microsoft Graph API responses**, to use your application with test data
@@ -11,9 +11,9 @@ Microsoft Graph Chaos Proxy allows you to verify that your application, that use
11
11
12
12
API errors are hard to replicate because they occur only in specific circumstances, often when the application is under heavy load. Because developers typically work on their own tenants, they can only verify if their application properly handles errors after the application has been deployed to production and put under heavy load. This makes for a poor developer experience.
13
13
14
-
With Graph Chaos Proxy you can see how your application responds to different errors that could be returned by the API.
14
+
With Graph Developer Proxy you can see how your application responds to different errors that could be returned by the API.
15
15
16
-
You can test your existing applications without any changes, even if you don't have access to their code and they're not using Microsoft Graph SDKs. Graph Chaos Proxy registers itself as a proxy on your machine and intercepts all network traffic. It passes through all requests and only responds to requests to the Microsoft Graph API.
16
+
You can test your existing applications without any changes, even if you don't have access to their code and they're not using Microsoft Graph SDKs. Graph Developer Proxy registers itself as a proxy on your machine and intercepts all network traffic. It passes through all requests and only responds to requests to the Microsoft Graph API.
17
17
18
18
## Features
19
19
@@ -34,42 +34,42 @@ You can test your existing applications without any changes, even if you don't h
34
34
35
35
## Usage
36
36
37
-
### Install Graph Chaos Proxy
37
+
### Install Graph Developer Proxy
38
38
39
39
To install the proxy is easy
40
40
41
-
- Download the latest version of the ZIP file for your operating system from the [Releases](https://github.com/microsoftgraph/msgraph-chaos-proxy/releases) page
41
+
- Download the latest version of the ZIP file for your operating system from the [Releases](https://github.com/microsoftgraph/msgraph-developer-proxy/releases) page
42
42
- Extract the archive to a folder of your choice
43
43
44
-
Graph Chaos Proxy doesn't need an installation and you can run it from any location on your machine.
44
+
Graph Developer Proxy doesn't need an installation and you can run it from any location on your machine.
45
45
46
46
> **Tip**
47
47
>
48
-
> To fully benefit of all features of Graph Chaos Proxy, add its location to the environment path. That way, you'll be able to start it from any directory and will be able to use project-specific mocks.
48
+
> To fully benefit of all features of Graph Developer Proxy, add its location to the environment path. That way, you'll be able to start it from any directory and will be able to use project-specific mocks.
49
49
50
50
### First-time use
51
51
52
52
#### Windows
53
53
54
-
When started, Graph Chaos Proxy automatically registers itself as a system-wide proxy on your machine.
54
+
When started, Graph Developer Proxy automatically registers itself as a system-wide proxy on your machine.
55
55
56
-
When you start Graph Chaos Proxy for the first time, you'll be prompted to install a local certificate. This certificate is necessary to decrypt requests to the Microsoft Graph API.
56
+
When you start Graph Developer Proxy for the first time, you'll be prompted to install a local certificate. This certificate is necessary to decrypt requests to the Microsoft Graph API.
57
57
58
-
After installing the certificate, you'll be also prompted to allow Graph Chaos Proxy to communicate on your private and public network.
58
+
After installing the certificate, you'll be also prompted to allow Graph Developer Proxy to communicate on your private and public network.
59
59
60
60
#### macOS
61
61
62
-
- make the Graph Chaos Proxy binary executable:
63
-
- open terminal and change the working directory to the location of Graph Chaos Proxy
64
-
- run `chmod +x ./msgraph-chaos-proxy`
65
-
- open the location of Graph Chaos Proxy in Finder
66
-
- on the keyboard press **Option** and open the context menu of the **msgraph-chaos-proxy** executable. From the context menu, choose **Open**, in the dialog choose **Open**
62
+
- make the Graph Developer Proxy binary executable:
63
+
- open terminal and change the working directory to the location of Graph Developer Proxy
64
+
- run `chmod +x ./msgraph-developer-proxy`
65
+
- open the location of Graph Developer Proxy in Finder
66
+
- on the keyboard press **Option** and open the context menu of the **msgraph-developer-proxy** executable. From the context menu, choose **Open**, in the dialog choose **Open**
67
67
- trust the certificate to decrypt SSL traffic:
68
68
- Open **KeyChain Access**
69
69
- in the search box, search for **Titanium Root Certificate Authority**
70
70
- open the certificate and in the **Trust** section, set **Always Trust**
71
71
- close the certificate window and confirm changes
72
-
- set Graph Chaos Proxy as your system proxy:
72
+
- set Graph Developer Proxy as your system proxy:
73
73
- in **Network preferences**, select your adapter and click the **Advanced...** button
74
74
- open **Proxies**
75
75
- select **Secure Web Proxy (HTTPS)**
@@ -92,17 +92,17 @@ Depending on the configured fail ratio, the proxy will either pass the request t
92
92
>
93
93
> When closing the proxy, press the Enter key in the proxy's window, so that the proxy unregisters itself from your machine. If you terminate the proxy's process, you will lose network connection. To restore your connection in such case, start the proxy again, and close it by pressing Enter.
94
94
95
-
### Uninstall Graph Chaos Proxy
95
+
### Uninstall Graph Developer Proxy
96
96
97
-
Remove the folder with proxy from your disk. Graph Chaos Proxy doesn't create any additional files or registry entries (Windows) on your machine. Remove the certificate installed by Graph Chaos Proxy.
97
+
Remove the folder with proxy from your disk. Graph Developer Proxy doesn't create any additional files or registry entries (Windows) on your machine. Remove the certificate installed by Graph Developer Proxy.
98
98
99
99
On macOS remove the **~/.config/rootCert.pfx** file.
100
100
101
101
## Configuration
102
102
103
103
### Mock responses
104
104
105
-
Graph Chaos Proxy offers you the ability to define mock responses to specific Graph API calls. This capability is invaluable if you want to test your application with specific test cases or want to demonstrate your application with a set of data that is often time-sensitive and inconvenient to manage on an actual Microsoft 365 tenant.
105
+
Graph Developer Proxy offers you the ability to define mock responses to specific Graph API calls. This capability is invaluable if you want to test your application with specific test cases or want to demonstrate your application with a set of data that is often time-sensitive and inconvenient to manage on an actual Microsoft 365 tenant.
106
106
107
107
#### Mock responses structure
108
108
@@ -321,7 +321,7 @@ for request `GET /v1.0/users/48d31887-5fad-4d73-a9f5-3c356e68a038`, the proxy wo
321
321
322
322
#### Respond to requests with binary data
323
323
324
-
For some requests you might want to respond with binary data like documents or images. In Graph Chaos Proxy, you can define a binary response by setting the `responseBody` to a string value that starts with `@` followed by file path relative to the current working directory, for example:
324
+
For some requests you might want to respond with binary data like documents or images. In Graph Developer Proxy, you can define a binary response by setting the `responseBody` to a string value that starts with `@` followed by file path relative to the current working directory, for example:
325
325
326
326
```json
327
327
{
@@ -342,7 +342,7 @@ When you call `GET /v1.0/users/[email protected]/photo/$value`, you'll get the ima
342
342
343
343
### Settings
344
344
345
-
Graph Chaos Proxy comes with several settings that you can use to control how the proxy should run. You can configure these settings by defining them in the `appsettings.json` file in the proxy's installation folder or using options in the command line.
345
+
Graph Developer Proxy comes with several settings that you can use to control how the proxy should run. You can configure these settings by defining them in the `appsettings.json` file in the proxy's installation folder or using options in the command line.
346
346
347
347
Setting|Description|Command-line option|Allowed values|Default value
348
348
--|--|--|--|--
@@ -356,20 +356,20 @@ Setting|Description|Command-line option|Allowed values|Default value
Will configure the proxy listening on port 8080 to fail 50% of requests with an http status code of either 429 or 503 and ignore any mock responses that may have been provided in the `responses.json` file
363
363
364
364
## Frequently Asked Questions
365
365
366
-
### Does Graph Chaos Proxy upload any data to Microsoft?
366
+
### Does Graph Developer Proxy upload any data to Microsoft?
367
367
368
368
No, it doesn't. While the proxy intercepts all network traffic on your machine, it doesn't upload any data to Microsoft.
369
369
370
-
### I've got no internet connection after using Graph Chaos Proxy
370
+
### I've got no internet connection after using Graph Developer Proxy
371
371
372
-
If you terminate the Graph Chaos Proxy process, the proxy won't be able to unregister itself and you won't have network connection on your machine. To restore network connection, start the proxy and close it by pressing Enter, which will gracefully close the proxy unregistering it on your machine and restoring the regular network connection.
372
+
If you terminate the Graph Developer Proxy process, the proxy won't be able to unregister itself and you won't have network connection on your machine. To restore network connection, start the proxy and close it by pressing Enter, which will gracefully close the proxy unregistering it on your machine and restoring the regular network connection.
0 commit comments