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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\API\test\Unit;
use Piwik\DataTable;
use Piwik\Plugins\API\Renderer\Csv;
/**
* @group Plugin
* @group API
*/
class CsvRendererTest extends \PHPUnit\Framework\TestCase
{
/**
* @var Csv
*/
private $builder;
public function setUp(): void
{
$this->builder = $this->makeBuilder(array('method' => 'MultiSites_getAll', 'convertToUnicode' => 0));
}
public function test_renderSuccess_shouldIncludeMessage()
{
$response = $this->builder->renderSuccess('ok');
$this->assertEquals("message
ok", $response);
}
public function test_renderException_shouldIncludeTheMessageAndNotExceptionMessage()
{
$response = $this->builder->renderException("The error message", new \Exception('The other message'));
$this->assertEquals('Error: The error message', $response);
}
public function test_renderException_shouldRespectNewlines()
{
$response = $this->builder->renderException("The\nerror\nmessage", new \Exception('The other message'));
$this->assertEquals('Error: The
error
message', $response);
}
public function test_renderObject_shouldReturAnError()
{
$response = $this->builder->renderObject(new \stdClass());
$this->assertEquals('Error: The API cannot handle this data structure.', $response);
}
public function test_renderResource_shouldReturAnError()
{
$response = $this->builder->renderResource(new \stdClass());
$this->assertEquals('Error: The API cannot handle this data structure.', $response);
}
public function test_renderScalar_shouldConvertToUnicodeByDefault()
{
$builder = $this->makeBuilder(array('method' => 'MultiSites_getAll'));
$response = $builder->renderScalar(true);
$this->assertStringStartsWith(chr(255) . chr(254), $response);
}
public function test_renderScalar_shouldReturnABooleanAsIntegerWrappedInTable()
{
$response = $this->builder->renderScalar(true);
$this->assertEquals('value
1', $response);
}
public function test_renderScalar_shouldReturnAnIntegerWrappedInTable()
{
$response = $this->builder->renderScalar(5);
$this->assertEquals('value
5', $response);
}
public function test_renderScalar_shouldReturnAStringWrappedInValue()
{
$response = $this->builder->renderScalar('The Output');
$this->assertEquals('value
The Output', $response);
}
public function test_renderScalar_shouldNotRemoveLineBreaks()
{
$response = $this->builder->renderScalar('The\nOutput');
$this->assertEquals('value
The\nOutput', $response);
}
/**
* @dataProvider getCellValuesToPrefixOrNot
*/
public function test_renderScalar_whenCellValueIsFormula_shouldPrefixWithQuote($value, $expectedCsvValue)
{
$response = $this->builder->renderScalar($value);
$this->assertEquals("value\n$expectedCsvValue", $response);
}
public function getCellValuesToPrefixOrNot()
{
// input, expected csv output
return array(
// we prefix with quotes
array('=test()', '\'=test()'),
array('=test()%%', '\'=test()%%'),
array('=1+1', '\'=1+1'),
array('@1+1', '\'@1+1'),
array('+1+1', '\'+1+1'),
array('+1+test()', '\'+1+test()'),
array('-1+1', '\'-1+1'),
array('@-1+1', '\'@-1+1'),
array('-test()', '\'-test()'),
array('-te,st()', '"\'-te,st()"'),
array('-te"st()', '"\'-te""st()"'),
// we do not need to prefix with quote
array('1', '1'),
array('2', '2'),
array('2@', '2@'),
array('20000000', '20000000'),
array('10%', '10%'),
array('%%', '%%'),
array('10.5%', '10.5%'),
array('-10.5%', '-10.5%'),
array('+10,5%', '"\'+10,5%"'),
array('10,5', '"10,5"'),
array('1+test()', '1+test()'),
array('1+test@', '1+test@'),
array('%10%5', '%10%5'),
array('', ''),
array(0, '0'),
array(2.2, '2.2'),
array(-2.2, '-2.2'),
array(false, '0'),
array(null, ''),
);
}
/**
* @dataProvider getCellValuesToPrefixOrNot
*/
public function test_renderDataTable_shouldRenderFormulas($value, $expectedValue)
{
$dataTable = new DataTable();
$dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => $value));
$response = $this->builder->renderDataTable($dataTable);
$this->assertEquals("nb_visits,nb_random\n5,$expectedValue", $response);
}
public function test_renderDataTable_shouldRenderABasicDataTable()
{
$dataTable = new DataTable();
$dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10));
$response = $this->builder->renderDataTable($dataTable);
$this->assertEquals('nb_visits,nb_random
5,10', $response);
}
public function test_renderDataTable_shouldNotRenderSubtables_AsItIsNotSupportedYet()
{
$subtable = new DataTable();
$subtable->addRowFromSimpleArray(array('nb_visits' => 2, 'nb_random' => 6));
$dataTable = new DataTable();
$dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10));
$dataTable->getFirstRow()->setSubtable($subtable);
$response = $this->builder->renderDataTable($dataTable);
$this->assertEquals('nb_visits,nb_random
5,10', $response);
}
public function test_renderDataTable_shouldRenderDataTableMaps()
{
$map = new DataTable\Map();
$dataTable = new DataTable();
$dataTable->addRowFromSimpleArray(array('nb_visits' => 5, 'nb_random' => 10));
$dataTable2 = new DataTable();
$dataTable2->addRowFromSimpleArray(array('nb_visits' => 3, 'nb_random' => 6));
$map->addTable($dataTable, 'table1');
$map->addTable($dataTable2, 'table2');
$response = $this->builder->renderDataTable($map);
$this->assertEquals('defaultKeyName,nb_visits,nb_random
table1,5,10
table2,3,6', $response);
}
public function test_renderDataTable_shouldRenderSimpleDataTable()
{
$dataTable = new DataTable\Simple();
$dataTable->addRowsFromArray(array('nb_visits' => 3, 'nb_random' => 6));
$response = $this->builder->renderDataTable($dataTable);
$this->assertEquals('nb_visits,nb_random
3,6', $response);
}
public function test_renderArray_ShouldConvertSimpleArrayToJson()
{
$input = array(1, 2, 5, 'string', 10);
$response = $this->builder->renderArray($input);
$this->assertEquals('1
2
5
string
10', $response);
}
public function test_renderArray_ShouldRenderAnEmptyArray()
{
$response = $this->builder->renderArray(array());
$this->assertEquals('No data available', $response);
}
public function test_renderArray_ShouldConvertAssociativeArrayToJson()
{
$input = array('nb_visits' => 6, 'nb_random' => 8);
$response = $this->builder->renderArray($input);
$this->assertEquals('nb_visits,nb_random
6,8', $response);
}
public function test_renderArray_ShouldConvertsIndexedAssociativeArrayToJson()
{
$input = array(
array('nb_visits' => 6, 'nb_random' => 8),
array('nb_visits' => 3, 'nb_random' => 4)
);
$response = $this->builder->renderArray($input);
$this->assertEquals('nb_visits,nb_random
6,8
3,4', $response);
}
public function test_renderArray_ShouldConvertMultiDimensionalStandardArrayToJson()
{
$input = array("firstElement",
array(
"firstElement",
"secondElement",
),
"thirdElement");
$actual = $this->builder->renderArray($input);
$this->assertEquals('0,1,2
firstElement,,
firstElement,secondElement,
,,thirdElement', $actual);
}
public function test_renderArray_ShouldConvertMultiDimensionalAssociativeArrayToJson()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Data structure returned is not convertible in the requested format');
$input = array(
"firstElement" => "isFirst",
"secondElement" => array(
"firstElement" => "isFirst",
"secondElement" => "isSecond",
),
"thirdElement" => "isThird");
$this->builder->renderArray($input);
}
public function test_renderArray_ShouldConvertMultiDimensionalIndexArrayToJson()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Data structure returned is not convertible in the requested format');
$input = array(array("firstElement",
array(
"firstElement",
"secondElement",
),
"thirdElement"));
$this->builder->renderArray($input);
}
public function test_renderArray_ShouldConvertMultiDimensionalMixedArrayToJson()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('Data structure returned is not convertible in the requested format');
$input = array(
"firstElement" => "isFirst",
array(
"firstElement",
"secondElement",
),
"thirdElement" => array(
"firstElement" => "isFirst",
"secondElement" => "isSecond",
)
);
$this->builder->renderArray($input);
}
private function makeBuilder($request)
{
return new Csv($request);
}
}
|