/
GrailsMockHttpServletRequest.groovy
528 lines (445 loc) · 14.6 KB
/
GrailsMockHttpServletRequest.groovy
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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
/*
* Copyright 2008 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.codehaus.groovy.grails.plugins.testing
import grails.artefact.ApiDelegate
import grails.converters.JSON
import grails.converters.XML
import javax.servlet.AsyncContext
import javax.servlet.AsyncEvent
import javax.servlet.AsyncListener
import javax.servlet.DispatcherType
import javax.servlet.ServletContext
import javax.servlet.ServletRequest
import javax.servlet.ServletResponse
import javax.servlet.http.HttpServletRequest
import javax.servlet.http.HttpServletResponse
import javax.servlet.http.Part
import org.codehaus.groovy.grails.plugins.web.api.RequestMimeTypesApi
import org.codehaus.groovy.grails.web.mime.MimeType
import org.codehaus.groovy.grails.web.servlet.GrailsApplicationAttributes
import org.codehaus.groovy.grails.web.servlet.mvc.GrailsWebRequest
import org.codehaus.groovy.grails.web.util.WebUtils
import org.springframework.http.HttpHeaders
import org.springframework.http.HttpMethod
import org.springframework.mock.web.MockHttpServletRequest
import org.springframework.util.Assert
import org.springframework.util.LinkedMultiValueMap
import org.springframework.util.MultiValueMap
import org.springframework.web.multipart.MultipartFile
import org.springframework.web.multipart.MultipartHttpServletRequest
/**
* A custom mock HTTP servlet request that provides the extra properties
* and methods normally injected by the "servlets" plugin.
*/
class GrailsMockHttpServletRequest extends MockHttpServletRequest implements MultipartHttpServletRequest{
@ApiDelegate(HttpServletRequest) RequestMimeTypesApi requestMimeTypesApi = new RequestMimeTypesApi()
boolean invalidToken
MultiValueMap multipartFiles = new LinkedMultiValueMap<String, MultipartFile>()
private Map<String, String> multipartContentTypes = Collections.emptyMap()
private Map<String, HttpHeaders> multipartHeaders = Collections.emptyMap()
private HttpHeaders httpHeaders = new HttpHeaders()
HttpHeaders requestHeaders
HttpMethod requestMethod = HttpMethod.GET
private cachedJson
private cachedXml
DispatcherType dispatcherType
AsyncContext asyncContext
/**
* Sets the request format to use
* @param format The request format
*/
void setFormat(String format) {
setAttribute(GrailsApplicationAttributes.CONTENT_FORMAT, format)
}
@Override
void setContentType(String newContentType) {
super.setContentType(newContentType)
setAttribute(GrailsApplicationAttributes.REQUEST_FORMATS, [new MimeType(newContentType)] as MimeType[])
}
/**
* Sets the body of the request to be a json packet
*
* @param sourceJson The source json
*/
void setJson(Object sourceJson) {
setContentType('application/json; charset=UTF-8')
setFormat('json')
if (sourceJson instanceof String) {
setContent(sourceJson.getBytes("UTF-8"))
}
else if (sourceJson instanceof JSON) {
setContent(sourceJson.toString().getBytes("UTF-8"))
}
else {
setContent(new JSON(sourceJson).toString().getBytes("UTF-8"))
}
getAttribute("org.codehaus.groovy.grails.WEB_REQUEST")?.informParameterCreationListeners()
}
/**
* Sets the body of the request to be an XML packet
*
* @param sourceXml
*/
void setXml(Object sourceXml) {
setContentType("text/xml; charset=UTF-8")
setFormat("xml")
if (sourceXml instanceof String) {
setContent(sourceXml.getBytes("UTF-8"))
}
else {
XML xml = new XML(sourceXml)
setContent(xml.toString().getBytes("UTF-8"))
}
getAttribute("org.codehaus.groovy.grails.WEB_REQUEST")?.informParameterCreationListeners()
}
void setXML(Object sourceXml) {
setXml(sourceXml)
}
void setJSON(Object sourceJson) {
setJson(sourceJson)
}
/**
* Implementation of the dynamic "forwardURI" property.
*/
String getForwardURI() {
def result = getAttribute(WebUtils.FORWARD_REQUEST_URI_ATTRIBUTE)
if (!result) result = requestURI
return result
}
/**
* Sets the "forwardURI" property for the request.
*/
void setForwardURI(String uri) {
setAttribute(WebUtils.FORWARD_REQUEST_URI_ATTRIBUTE, uri)
}
/**
* Indicates whether this is an AJAX request or not (as far as
* Grails is concerned). Returns <code>true</code> if it is an
* AJAX request, otherwise <code>false</code>.
*/
boolean isXhr() {
return getHeader("X-Requested-With") == "XMLHttpRequest"
}
/**
* Makes this request an AJAX request as Grails understands it.
* This cannot be undone, so if you need a non-AJAX request you
* will have to create a new instance.
*/
void makeAjaxRequest() {
addHeader("X-Requested-With", "XMLHttpRequest")
}
/**
* Map-like access to request attributes, e.g. request["count"].
*/
def getAt(String key) {
return getAttribute(key)
}
/**
* Map-like setting of request attributes, e.g. request["count"] = 10.
*/
void putAt(String key, Object val) {
setAttribute(key, val)
}
/**
* Property access for request attributes.
*/
def getProperty(String name) {
def mp = getClass().metaClass.getMetaProperty(name)
return mp ? mp.getProperty(this) : getAttribute(name)
}
/**
* Property setting of request attributes.
*/
void setProperty(String name, value) {
def mp = getClass().metaClass.getMetaProperty(name)
if (mp) {
mp.setProperty(this, value)
}
else {
setAttribute(name, value)
}
}
boolean isGet() { method == "GET" }
boolean isPost() { method == "POST" }
/**
* Parses the request content as XML using XmlSlurper and returns
* the GPath result object. Throws an exception if there is no
* content or the content is not valid XML.
*/
def getXML() {
if (!cachedXml) {
cachedXml = GrailsMockHttpServletRequest.classLoader.loadClass("grails.converters.XML").parse(this)
}
return cachedXml
}
/**
* Parses the request content as JSON using the JSON converter.
* Throws an exception if there is no content or the content is
* not valid JSON.
*/
def getJSON() {
if (!cachedJson) {
cachedJson = GrailsMockHttpServletRequest.classLoader.loadClass("grails.converters.JSON").parse(this)
}
return cachedJson
}
/**
* Adds a "find()" method to the request that searches the request's
* attributes. Returns the first attribute for which the closure
* returns <code>true</code>, just like the normal Groovy find() method.
*/
def find(Closure c) {
def result = [:]
for (String name in attributeNames) {
def match = false
switch (c.parameterTypes.length) {
case 0:
match = c.call()
break
case 1:
match = c.call(key:name, value:getAttribute(name))
break
default:
match = c.call(name, getAttribute(name))
}
if (match) {
result[name] = getAttribute(name)
break
}
}
return result
}
/**
* Like the {@link #find(Closure)} method, this searches the request
* attributes. Returns all the attributes that match the closure
* conditions.
*/
def findAll(Closure c) {
def results = [:]
for (String name in attributeNames) {
def match = false
switch (c.parameterTypes.length) {
case 0:
match = c.call()
break
case 1:
match = c.call(key:name, value:getAttribute(name))
break
default:
match = c.call(name, getAttribute(name))
}
if (match) { results[name] = getAttribute(name) }
}
results
}
/**
* Iterates over the request attributes.
*/
def each(Closure c) {
for (String name in attributeNames) {
switch (c.parameterTypes.length) {
case 0:
c.call()
break
case 1:
c.call(key:name, value:getAttribute(name))
break
default:
c.call(name, getAttribute(name))
}
}
}
/**
* {@inheritDoc }
*/
Iterator<String> getFileNames() {
return multipartFiles.keySet().iterator()
}
/**
* {@inheritDoc }
*/
MultipartFile getFile(String name) {
return multipartFiles.getFirst(name)
}
/**
* {@inheritDoc }
*/
List<MultipartFile> getFiles(String name) {
return multipartFiles.get(name)
}
/**
* {@inheritDoc }
*/
Map<String, MultipartFile> getFileMap() {
return multipartFiles
}
/**
* {@inheritDoc }
*/
MultiValueMap<String, MultipartFile> getMultiFileMap() {
return multipartFiles
}
/**
* Add a file to this request. The parameter name from the multipart
* form is taken from the {@link MultipartFile#getName()}.
* @param file multipart file to be added
*/
void addFile(MultipartFile file) {
setMethod("POST")
setContentType("multipart/form-data")
Assert.notNull(file, "MultipartFile must not be null")
multipartFiles.add(file.getName(), file)
}
/**
* Add a file for the given location and bytes
*
* @param location The location
* @param contents The bytes
*/
void addFile(String location, byte[] contents) {
setMethod("POST")
setContentType("multipart/form-data")
multipartFiles.add(location, new GrailsMockMultipartFile(location, contents))
}
@Override
void clearAttributes() {
super.clearAttributes()
multipartFiles.clear()
multipartContentTypes.clear()
httpHeaders.clear()
}
String getMultipartContentType(String paramOrFileName) {
return multipartContentTypes.get(paramOrFileName)
}
String setMultipartContentType(String paramOrFileName, String contentType) {
return multipartContentTypes.put(paramOrFileName, contentType)
}
HttpHeaders getMultipartHeaders(String paramOrFileName) {
return multipartHeaders.get(paramOrFileName)
}
HttpHeaders setMultipartHeaders(String paramOrFileName, HttpHeaders headers) {
return multipartHeaders.put(paramOrFileName, headers)
}
Collection<Part> getParts() {
getFileMap().values().collect {new MockPart(it)}
}
Part getPart(String name) {
MultipartFile file = getFile(name)
if (file) {
return new MockPart(file)
}
}
AsyncContext startAsync() {
def webRequest = GrailsWebRequest.lookup()
def response = webRequest?.currentResponse
if (response == null) {
response = new GrailsMockHttpServletResponse()
}
startAsync(this,response)
}
AsyncContext startAsync(ServletRequest servletRequest, ServletResponse servletResponse) {
return new MockAsyncContext(servletRequest, servletResponse)
}
boolean isAsyncStarted() { asyncContext != null }
boolean isAsyncSupported() { true }
}
class MockPart implements Part {
MultipartFile file
MultiValueMap<String, String> headers = new LinkedMultiValueMap<String, String>()
MockPart(MultipartFile file) {
this.file = file
}
InputStream getInputStream() {
file.inputStream
}
String getContentType() {
file.contentType
}
String getName() {
file.name
}
long getSize() {
file.size
}
void write(String fileName) {
file.transferTo(new File(fileName))
}
void delete() {
// no-op
}
String getHeader(String name) {
return headers.getFirst(name)
}
Collection<String> getHeaders(String name) {
return headers[name]
}
Collection<String> getHeaderNames() {
return headers.keySet()
}
}
class MockAsyncContext implements AsyncContext {
ServletRequest request
ServletResponse response
String dispatchUri
long timeout = -1
List asyncListeners = []
MockAsyncContext(HttpServletRequest request, HttpServletResponse response) {
this.request = request
this.response = response
}
boolean hasOriginalRequestAndResponse() {
return true
}
void dispatch() {
dispatchUri = request.requestURI
}
void dispatch(String path) {
dispatchUri = path
}
void dispatch(ServletContext context, String path) {
dispatchUri = path
}
void complete() {
// no op
}
void start(Runnable run) {
try {
for (listener in asyncListeners) {
AsyncListener al = listener.listener
al.onStartAsync(listener.event)
}
run.run()
for (listener in asyncListeners) {
AsyncListener al = listener.listener
al.onComplete(listener.event)
}
} catch (e) {
for (listener in asyncListeners) {
AsyncListener al = listener.listener
al.onError(new AsyncEvent(this, e))
}
}
}
void addListener(AsyncListener listener) {
asyncListeners << [listener:listener, event:new AsyncEvent(this, request, response)]
}
void addListener(AsyncListener listener, ServletRequest servletRequest, ServletResponse servletResponse) {
asyncListeners << [listener:listener, event:new AsyncEvent(this, servletRequest, servletResponse)]
}
def <T extends AsyncListener> T createListener(Class<T> clazz) {
return clazz.newInstance()
}
}