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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\Unit\API;
use Exception;
use Piwik\API\ResponseBuilder;
use Piwik\Config;
use Piwik\DataTable;
use Piwik\Plugin\Manager;
/**
* @group Core
*/
class ResponseBuilderTest extends \PHPUnit\Framework\TestCase
{
public function setUp(): void
{
Manager::getInstance()->loadPlugins(array('API'));
}
public function test_getResponseException_shouldFormatExceptionDependingOnFormatAndAddDebugHelp()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponseException(new Exception('My Message'));
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>
<error message="My Message
--> To temporarily debug this error further, set const PIWIK_PRINT_ERROR_BACKTRACE=true; in index.php" />
</result>', $response);
}
public function test_getResponse_shouldTreatAsSuccessIfNoValue()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(null);
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>
<success message="ok" />
</result>', $response);
}
public function test_getResponse_shouldNotReturnAnythingIfContentWasOutput()
{
echo 5;
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(null);
$this->assertNull($response);
ob_clean();
}
public function test_getResponse_shouldHandleScalar()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(true);
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>1</result>', $response);
$response = $builder->getResponse(5);
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>5</result>', $response);
$response = $builder->getResponse('string');
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>string</result>', $response);
}
public function test_getResponse_shouldHandleDataTable()
{
$builder = new ResponseBuilder('xml', array());
$dataTable = new DataTable();
$dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10));
$response = $builder->getResponse($dataTable);
$this->assertEquals('<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<nb_visits>5</nb_visits>
<nb_random>10</nb_random>
</row>
</result>', $response);
}
public function test_getResponse_shouldHandleObject()
{
$object = new \stdClass();
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse($object);
$this->assertSame('<?xml version="1.0" encoding="utf-8" ?>
<result>
<error message="The API cannot handle this data structure." />
</result>', $response);
$builder = new ResponseBuilder('original', array());
$response = $builder->getResponse($object);
$this->assertSame($object, $response);
}
public function test_getResponse_shouldHandleResource()
{
$resource = curl_init();
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse($resource);
$this->assertSame('<?xml version="1.0" encoding="utf-8" ?>
<result>
<error message="The API cannot handle this data structure." />
</result>', $response);
$builder = new ResponseBuilder('original', array());
$response = $builder->getResponse($resource);
$this->assertSame($resource, $response);
}
public function test_getResponse_shouldHandleArray()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(array(1, 2, 3, 'string', 10));
$this->assertSame('<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>1</row>
<row>2</row>
<row>3</row>
<row>string</row>
<row>10</row>
</result>', $response);
}
public function test_getResponse_shouldHandleAssociativeArray()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(array('test' => 'two', 'test2' => 'three'));
$this->assertSame('<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<test>two</test>
<test2>three</test2>
</row>
</result>', $response);
}
public function test_getResponse_shouldHandleIndexedAssociativeArray()
{
$builder = new ResponseBuilder('xml', array());
$response = $builder->getResponse(array(array('test' => 'two', 'test2' => 'three')));
$this->assertSame('<?xml version="1.0" encoding="utf-8" ?>
<result>
<row>
<test>two</test>
<test2>three</test2>
</row>
</result>', $response);
}
public function test_getResponse_shouldBeAbleToApplyFilterOnIndexedAssociativeArray()
{
$input = array();
for ($i = 0; $i < 10; $i++) {
$input[] = array('test' => 'two' . $i, 'test2' => 'three');
}
$builder = new ResponseBuilder('original', array('serialize' => 0));
$response = $builder->getResponse($input);
$this->assertEquals($input, $response);
$this->assertCount(10, $response);
$builder = new ResponseBuilder('original', array('serialize' => 0, 'showColumns' => 'test'));
$response = $builder->getResponse($input);
$this->assertEquals(array('test' => 'two0'), array_shift($response));
}
public function test_getResponse_shouldApplyFilterLimitOnIndexedArray()
{
$input = range(0, 100);
$expected = range(0, 14);
$this->assertLimitedResponseEquals($expected, $input, $limit = 15, $offset = null);
}
public function test_getResponse_shouldReturnEmptyArrayOnIndexedArray_IfOffsetIsTooHigh()
{
$input = range(0, 100);
$this->assertLimitedResponseEquals(array(), $input, $limit = 15, $offset = 200);
}
public function test_getResponse_shouldReturnAllOnIndexedArray_IfLimitIsTooHigh()
{
$input = range(0, 100);
$this->assertLimitedResponseEquals($input, $input, $limit = 200, $offset = null);
}
public function test_getResponse_shouldNotApplyFilterLimitOnIndexedArrayIfParamNotSet()
{
$input = range(0, 100);
$this->assertLimitedResponseEquals($input, $input, $limit = null, $offset = null);
}
public function test_getResponse_shouldApplyLimitOnIndexedArray_IfLimitIsDefaultFilterLimitValue()
{
$limit = Config::getInstance()->General['API_datatable_default_limit'];
$input = range(0, 2000);
$expected = range(0, $limit - 1);
$this->assertLimitedResponseEquals($expected, $input, $limit, $offset = 0);
}
private function assertLimitedResponseEquals($expectedResponse, $input, $limit, $offset = 0)
{
$params = array('serialize' => 0);
if (!is_null($limit)) {
$params['filter_limit'] = $limit;
}
if (!is_null($offset)) {
$params['filter_offset'] = $offset;
}
$builder = new ResponseBuilder('json', $params);
$response = json_decode($builder->getResponse($input), true);
$this->assertEquals($expectedResponse, $response);
}
public function test_getResponse_shouldAlwaysApplyDefaultFilterLimit_EvenWhenResponseIsAnArray()
{
$input = range(0, 200);
$limit = Config::getInstance()->General['API_datatable_default_limit'];
$builder = new ResponseBuilder('json', array(
'serialize' => 0,
'api_datatable_default_limit' => $limit,
'filter_limit' => $limit,
'filter_offset' => 0));
$response = $builder->getResponse($input);
$this->assertEquals(range(0, 99), json_decode($response, true));
}
public function test_getResponse_shouldApplyLimit_IfLimitIsSetBySystemButDifferentToDefaultLimit()
{
$input = range(0, 200);
$defaultLimit = Config::getInstance()->General['API_datatable_default_limit'];
$limit = $defaultLimit - 1;
$builder = new ResponseBuilder('json', array(
'serialize' => 0,
'api_datatable_default_limit' => $defaultLimit,
'filter_limit' => $limit,
'filter_offset' => 0));
$response = $builder->getResponse($input);
$this->assertEquals(range(0, $limit - 1), json_decode($response, true));
}
public function test_getResponse_shouldApplyFilterOffsetOnIndexedArray_IfFilterLimitIsGiven()
{
$input = range(0, 100);
$expected = range(30, 44);
$this->assertLimitedResponseEquals($expected, $input, $limit = 15, $offset = 30);
}
public function test_getResponse_shouldApplyFilterOffsetOnIndexedArray_IfNoFilterLimitIsSetButOffset()
{
$input = range(0, 100);
$expected = range(30, 100);
$this->assertLimitedResponseEquals($expected, $input, $limit = null, $offset = 30);
}
public function test_getResponse_shouldReturnEmptyArrayOnIndexedArray_IfFilterLimitIsZero()
{
$input = range(0, 100);
$this->assertLimitedResponseEquals($expected = array(), $input, $limit = 0, $offset = 30);
}
public function test_getResponse_shouldApplyFilterOffsetOnIndexedArray_IfFilterLimitIsMinusOne()
{
$input = range(0, 100);
$expected = range(30, 100);
$this->assertLimitedResponseEquals($expected, $input, $limit = -1, $offset = 30);
}
public function test_getResponse_shouldReturnAllOnIndexedArray_IfFilterLimitIsMinusOne()
{
$input = range(0, 100);
$this->assertLimitedResponseEquals($input, $input, $limit = -1, $offset = null);
}
public function test_getResponse_shouldApplyPattern_IfFilterColumnAndPatternIsGiven()
{
$input = array(
0 => array('name' => 'google', 'url' => 'www.google.com'),
1 => array('name' => 'ask', 'url' => 'www.ask.com'),
2 => array('name' => 'piwik', 'url' => 'piwik.org'),
3 => array('url' => 'nz.yahoo.com'),
4 => array('name' => 'amazon', 'url' => 'amazon.com'),
5 => array('url' => 'nz.piwik.org'),
);
$builder = new ResponseBuilder('json', array(
'serialize' => 0,
'filter_limit' => -1,
'filter_column' => array('name', 'url'),
'filter_pattern' => 'piwik'
));
$response = $builder->getResponse($input);
$expected = array(
2 => array('name' => 'piwik', 'url' => 'piwik.org'),
5 => array('url' => 'nz.piwik.org'),
);
$this->assertEquals($expected, json_decode($response, true));
}
public function test_getResponse_shouldBeAbleToApplyColumFilterAndLimitFilterOnIndexedAssociativeArray()
{
$input = array();
for ($i = 0; $i < 10; $i++) {
$input[] = array('test' => 'two' . $i, 'test2' => 'three');
}
$limit = 3;
$builder = new ResponseBuilder('json', array(
'serialize' => 0,
'filter_limit' => $limit,
'filter_offset' => 3,
'showColumns' => 'test'
));
$response = $builder->getResponse($input);
$this->assertEquals(array(
0 => array('test' => 'two3'),
1 => array('test' => 'two4'),
2 => array('test' => 'two5'),
), json_decode($response, true));
}
}
|