Skip to content

Commit e90e2ef

Browse files
waldekmastykarzwaldekmastykarz
authored
Extends MockResponsePlugin with body fragment (#640)
Updates version to v0.17.0
1 parent 3aba932 commit e90e2ef

11 files changed

+521
-6
lines changed

‎dev-proxy-abstractions/MockResponse.cs‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ public class MockResponseRequest
1414
public string Url { get; set; } = string.Empty;
1515
public string Method { get; set; } = "GET";
1616
public int? Nth { get; set; }
17+
public string? BodyFragment { get; set; }
1718
}
1819

1920
public class MockResponseResponse

‎dev-proxy-abstractions/dev-proxy-abstractions.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<RootNamespace>Microsoft.DevProxy.Abstractions</RootNamespace>
66
<ImplicitUsings>enable</ImplicitUsings>
77
<Nullable>enable</Nullable>
8-
<Version>0.16.1</Version>
8+
<Version>0.17.0</Version>
99
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
1010
</PropertyGroup>
1111

‎dev-proxy-plugins/Mocks/MockResponsePlugin.cs‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public class MockResponseConfiguration
2727
public bool BlockUnmockedRequests { get; set; } = false;
2828

2929
[JsonPropertyName("$schema")]
30-
public string Schema { get; set; } = "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v0.16.1/mockresponseplugin.schema.json";
30+
public string Schema { get; set; } = "https://raw.githubusercontent.com/microsoft/dev-proxy/main/schemas/v0.17.0/mockresponseplugin.schema.json";
3131
public IEnumerable<MockResponse> Mocks { get; set; } = Array.Empty<MockResponse>();
3232
}
3333

@@ -159,7 +159,9 @@ _configuration.Mocks is null ||
159159
if (mockResponse.Request is null) return false;
160160

161161
if (mockResponse.Request.Method != request.Method) return false;
162-
if (mockResponse.Request.Url == request.Url && IsNthRequest(mockResponse))
162+
if (mockResponse.Request.Url == request.Url &&
163+
HasMatchingBody(mockResponse, request) &&
164+
IsNthRequest(mockResponse))
163165
{
164166
return true;
165167
}
@@ -173,7 +175,9 @@ _configuration.Mocks is null ||
173175

174176
//turn mock URL with wildcard into a regex and match against the request URL
175177
var mockResponseUrlRegex = Regex.Escape(mockResponse.Request.Url).Replace("\\*", ".*");
176-
return Regex.IsMatch(request.Url, $"^{mockResponseUrlRegex}$") && IsNthRequest(mockResponse);
178+
return Regex.IsMatch(request.Url, $"^{mockResponseUrlRegex}$") &&
179+
HasMatchingBody(mockResponse, request) &&
180+
IsNthRequest(mockResponse);
177181
});
178182

179183
if (mockResponse is not null && mockResponse.Request is not null)
@@ -188,6 +192,30 @@ _configuration.Mocks is null ||
188192
return mockResponse;
189193
}
190194

195+
private bool HasMatchingBody(MockResponse mockResponse, Request request)
196+
{
197+
if (request.Method == "GET")
198+
{
199+
// GET requests don't have a body so we can't match on it
200+
return true;
201+
}
202+
203+
if (mockResponse.Request?.BodyFragment is null)
204+
{
205+
// no body fragment to match on
206+
return true;
207+
}
208+
209+
if (!request.HasBody || string.IsNullOrEmpty(request.BodyString))
210+
{
211+
// mock defines a body fragment but the request has no body
212+
// so it can't match
213+
return false;
214+
}
215+
216+
return request.BodyString.Contains(mockResponse.Request.BodyFragment, StringComparison.OrdinalIgnoreCase);
217+
}
218+
191219
private bool IsNthRequest(MockResponse mockResponse)
192220
{
193221
if (mockResponse.Request is null || mockResponse.Request.Nth is null)

‎dev-proxy-plugins/dev-proxy-plugins.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<Nullable>enable</Nullable>
77
<EnableDynamicLoading>true</EnableDynamicLoading>
88
<RunPostBuildEvent>OnOutputUpdated</RunPostBuildEvent>
9-
<Version>0.16.1</Version>
9+
<Version>0.17.0</Version>
1010
<IncludeSourceRevisionInInformationalVersion>false</IncludeSourceRevisionInInformationalVersion>
1111
</PropertyGroup>
1212
<PropertyGroup Condition="'$(Configuration)'=='Release'">

‎dev-proxy/dev-proxy.csproj‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<Nullable>enable</Nullable>
99
<PackageLicenseFile>LICENSE</PackageLicenseFile>
1010
<Title>Dev Proxy</Title>
11-
<Version>0.16.1</Version>
11+
<Version>0.17.0</Version>
1212
<Company>Microsoft</Company>
1313
<Product>Dev Proxy</Product>
1414
<AssemblyName>devproxy</AssemblyName>

‎schemas/v0.17.0/crudapiplugin.schema.json‎

Lines changed: 135 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"title": "CRUD API plugin API definition",
4+
"description": "API definition for use with the CRUD API Dev Proxy plugin",
5+
"type": "object",
6+
"properties": {
7+
"$schema": {
8+
"type": "string"
9+
},
10+
"baseUrl": {
11+
"type": "string"
12+
},
13+
"dataFile": {
14+
"type": "string"
15+
},
16+
"actions": {
17+
"type": "array",
18+
"items": {
19+
"type": "object",
20+
"properties": {
21+
"action": {
22+
"type": "string",
23+
"enum": [
24+
"create",
25+
"getAll",
26+
"getOne",
27+
"getMany",
28+
"merge",
29+
"update",
30+
"delete"
31+
]
32+
},
33+
"url": {
34+
"type": "string"
35+
},
36+
"query": {
37+
"type": "string"
38+
},
39+
"method": {
40+
"type": "string",
41+
"enum": [
42+
"GET",
43+
"POST",
44+
"PUT",
45+
"PATCH",
46+
"DELETE"
47+
]
48+
},
49+
"auth": {
50+
"type": "string",
51+
"enum": [
52+
"none",
53+
"entra"
54+
]
55+
},
56+
"entraAuthConfig": {
57+
"type": "object",
58+
"properties": {
59+
"audience": {
60+
"type": "string"
61+
},
62+
"issuer": {
63+
"type": "string"
64+
},
65+
"scopes": {
66+
"type": "array",
67+
"items": {
68+
"type": "string"
69+
}
70+
},
71+
"roles": {
72+
"type": "array",
73+
"items": {
74+
"type": "string"
75+
}
76+
},
77+
"validateLifetime": {
78+
"type": "boolean"
79+
},
80+
"validateSigningKey": {
81+
"type": "boolean"
82+
}
83+
}
84+
}
85+
},
86+
"required": [
87+
"action"
88+
],
89+
"additionalProperties": false
90+
}
91+
},
92+
"auth": {
93+
"type": "string",
94+
"enum": [
95+
"none",
96+
"entra"
97+
]
98+
},
99+
"entraAuthConfig": {
100+
"type": "object",
101+
"properties": {
102+
"audience": {
103+
"type": "string"
104+
},
105+
"issuer": {
106+
"type": "string"
107+
},
108+
"scopes": {
109+
"type": "array",
110+
"items": {
111+
"type": "string"
112+
}
113+
},
114+
"roles": {
115+
"type": "array",
116+
"items": {
117+
"type": "string"
118+
}
119+
},
120+
"validateLifetime": {
121+
"type": "boolean"
122+
},
123+
"validateSigningKey": {
124+
"type": "boolean"
125+
}
126+
}
127+
}
128+
},
129+
"required": [
130+
"baseUrl",
131+
"dataFile",
132+
"actions"
133+
],
134+
"additionalProperties": false
135+
}

‎schemas/v0.17.0/genericrandomerrorplugin.schema.json‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"title": "Dev Proxy GenericRandomErrorPlugin responses",
4+
"description": "Mocks for the Dev Proxy GenericRandomErrorPlugin",
5+
"type": "object",
6+
"properties": {
7+
"$schema": {
8+
"type":"string"
9+
},
10+
"responses": {
11+
"type": "array",
12+
"items": {
13+
"type": "object",
14+
"properties": {
15+
"body": {
16+
"type": [
17+
"object",
18+
"array",
19+
"string"
20+
]
21+
},
22+
"statusCode": {
23+
"type": "integer"
24+
},
25+
"headers": {
26+
"type": "array",
27+
"items": {
28+
"type": "object",
29+
"properties": {
30+
"name": {
31+
"type": "string"
32+
},
33+
"value": {
34+
"type": "string"
35+
}
36+
},
37+
"required": [
38+
"name",
39+
"value"
40+
]
41+
}
42+
}
43+
}
44+
}
45+
}
46+
},
47+
"required": [
48+
"responses"
49+
],
50+
"additionalProperties": false
51+
}

‎schemas/v0.17.0/mockrequestplugin.schema.json‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
{
2+
"$schema": "https://json-schema.org/draft/2020-12/schema",
3+
"title": "Dev Proxy MockRequestPlugin mocks",
4+
"description": "Mock request for the Dev Proxy MockRequestPlugin",
5+
"type": "object",
6+
"properties": {
7+
"$schema": {
8+
"type": "string"
9+
},
10+
"request": {
11+
"type": "object",
12+
"properties": {
13+
"url": {
14+
"type": "string",
15+
"format": "uri"
16+
},
17+
"method": {
18+
"type": "string",
19+
"enum": [
20+
"GET",
21+
"POST",
22+
"PUT",
23+
"PATCH",
24+
"DELETE",
25+
"HEAD",
26+
"OPTIONS",
27+
"CONNECT",
28+
"TRACE"
29+
]
30+
},
31+
"body": {
32+
"type": "object"
33+
},
34+
"headers": {
35+
"type": "array",
36+
"items": {
37+
"type": "object",
38+
"properties": {
39+
"name": {
40+
"type": "string"
41+
},
42+
"value": {
43+
"type": "string"
44+
}
45+
},
46+
"required": [
47+
"name",
48+
"value"
49+
]
50+
}
51+
}
52+
},
53+
"required": [
54+
"url"
55+
]
56+
}
57+
},
58+
"required": [
59+
"request"
60+
],
61+
"additionalProperties": false
62+
}

0 commit comments

Comments
 (0)