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
|
<?php
/**
* ownCloud - News
*
* @author Bernhard Posselt
* @copyright 2012 Bernhard Posselt dev@bernhard-posselt.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\News\Utility;
use OCP\IRequest;
use OCP\AppFramework\Http\Response;
/**
* Simple utility class for testing controllers
*/
abstract class ControllerTestUtility extends TestUtility {
/**
* Checks if a controllermethod has the expected annotations
* @param Controller/string $controller name or instance of the controller
* @param array $expected an array containing the expected annotations
* @param array $valid if you define your own annotations, pass them here
*/
protected function assertAnnotations($controller, $method, array $expected,
array $valid=array()){
$standard = array(
'Ajax',
'CSRFExemption',
'IsAdminExemption',
'IsSubAdminExemption',
'IsLoggedInExemption',
'API'
);
$possible = array_merge($standard, $valid);
// check if expected annotations are valid
foreach($expected as $annotation){
$this->assertTrue(in_array($annotation, $possible));
}
$reader = new MethodAnnotationReader($controller, $method);
foreach($expected as $annotation){
$this->assertTrue($reader->hasAnnotation($annotation));
}
}
/**
* Shortcut for testing expected headers of a response
* @param array $expected an array with the expected headers
* @param Response $response the response which we want to test for headers
*/
protected function assertHeaders(array $expected=array(), Response $response){
$headers = $reponse->getHeaders();
foreach($expected as $header){
$this->assertTrue(in_array($header, $headers));
}
}
/**
* Instead of using positional parameters this function instantiates
* a request by using a hashmap so its easier to only set specific params
* @param array $params a hashmap with the parameters for request
* @return Request a request instance
*/
protected function getRequest(array $params=array()) {
$mock = $this->getMockBuilder('\OCP\IRequest')
->getMock();
$merged = array();
foreach ($params as $key => $value) {
$merged = array_merge($value, $merged);
}
$mock->expects($this->any())
->method('getParam')
->will($this->returnCallback(function($index, $default) use ($merged) {
if (array_key_exists($index, $merged)) {
return $merged[$index];
} else {
return $default;
}
}));
// attribute access
if(array_key_exists('server', $params)) {
$mock->server = $params['server'];
}
return $mock;
}
}
|
