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
|
<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Plugins\Annotations\tests\System;
use Piwik\API\Request;
use Piwik\Date;
use Piwik\Plugins\Annotations\API;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\TestCase\SystemTestCase;
use Piwik\Tests\Fixtures\TwoSitesWithAnnotations;
use Exception;
/**
* @group Plugins
* @group AnnotationsTest
*/
class AnnotationsTest extends SystemTestCase
{
/** @var TwoSitesWithAnnotations */
public static $fixture = null;
public function setUp(): void
{
parent::setUp();
// Fixed time necessary for "last30" API tests.
Date::$now = strtotime('2012-03-03 12:00:00');
}
public function tearDown(): void
{
Date::$now = null;
parent::tearDown();
}
public static function getOutputPrefix()
{
return 'annotations';
}
public function getApiForTesting()
{
$idSite1 = self::$fixture->idSite1;
return array(
// get
array('Annotations.get', array('idSite' => $idSite1,
'date' => '2012-01-01',
'periods' => 'day',
'otherRequestParameters' => array('idNote' => 1))),
// getAll
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => '2011-12-01',
'periods' => array('day', 'week', 'month'))),
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => '2012-01-01',
'periods' => array('year'))),
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => '2012-03-01',
'periods' => array('week'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_lastN')),
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => '2012-01-26,2012-03-01',
'periods' => array('week'),
'testSuffix' => '_multiplePeriod')),
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => '2012-01-15,2012-02-15',
'periods' => array('range'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_range')),
array('Annotations.getAll', array('idSite' => $idSite1,
'date' => 'last30',
'periods' => array('range'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_last30')),
array('Annotations.getAll', array('idSite' => 'all',
'date' => '2012-01-01',
'periods' => array('month'),
'testSuffix' => '_multipleSites')),
array('Annotations.getAll', array('idSite' => $idSite1,
'testSuffix' => '_noDate')),
// getAnnotationCountForDates
array('Annotations.getAnnotationCountForDates', array('idSite' => $idSite1,
'date' => '2011-12-01',
'periods' => array('day', 'week', 'month'))),
array('Annotations.getAnnotationCountForDates', array('idSite' => $idSite1,
'date' => '2012-01-01',
'periods' => array('year'))),
array('Annotations.getAnnotationCountForDates', array('idSite' => $idSite1,
'date' => '2012-03-01',
'periods' => array('week'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_lastN')),
array('Annotations.getAnnotationCountForDates', array('idSite' => $idSite1,
'date' => '2012-01-15,2012-02-15',
'periods' => array('range'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_range')),
array('Annotations.getAnnotationCountForDates', array('idSite' => $idSite1,
'date' => 'last30',
'periods' => array('range'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_last30')),
array('Annotations.getAnnotationCountForDates', array('idSite' => 'all',
'date' => '2012-01-01',
'periods' => array('month'),
'testSuffix' => '_multipleSites')),
);
}
/**
* @dataProvider getApiForTesting
*/
public function testApi($api, $params)
{
$this->runApiTests($api, $params);
}
/**
* @dataProvider getTestAddSuccessData
*/
public function testAddSuccess(string $date, string $expectedDate)
{
$addResponse = API::getInstance()->add(
self::$fixture->idSite1,
$date,
$note = 'new note text single add'
);
unset($addResponse['id']); // unsetting id for comparison
unset($addResponse['idNote']);
$expectedAddResponse = [
'date' => $expectedDate,
'note' => 'new note text single add',
'starred' => 0,
'user' => 'superUserLogin',
'idsite' => 1,
'canEditOrDelete' => true,
];
$this->assertEquals($expectedAddResponse, $addResponse);
}
public function getTestAddSuccessData(): iterable
{
yield 'specific date' => ['2012-04-01', '2012-04-01'];
yield 'today' => ['today', '2012-03-03']; // based on fixed date in the test
yield 'yesterday' => ['yesterday', '2012-03-02'];
yield 'tomorrow' => ['tomorrow', '2012-03-04'];
}
public function testAddMultipleSitesFail()
{
self::expectError();
API::getInstance()->add("1,2,3", "2012-01-01", "whatever");
}
public function testAddInvalidDateFail()
{
self::expectException(Exception::class);
API::getInstance()->add(self::$fixture->idSite1, "invaliddate", "whatever");
}
public function testSaveMultipleSitesFail()
{
self::expectError();
API::getInstance()->save("1,2,3", 0);
}
public function testSaveInvalidDateFail()
{
self::expectException(Exception::class);
API::getInstance()->save(self::$fixture->idSite1, 0, "invaliddate");
}
public function testSaveInvalidNoteIdFail()
{
self::expectException(Exception::class);
API::getInstance()->save(self::$fixture->idSite1, -1);
}
public function testDeleteMultipleSitesFail()
{
self::expectError();
API::getInstance()->delete("1,2,3", 0);
}
public function testDeleteInvalidNoteIdFail()
{
self::expectException(Exception::class);
API::getInstance()->delete(self::$fixture->idSite1, -1);
}
public function testGetMultipleSitesFail()
{
self::expectError();
API::getInstance()->get("1,2,3", 0);
}
public function testGetInvalidNoteIdFail()
{
self::expectException(Exception::class);
API::getInstance()->get(self::$fixture->idSite1, -1);
}
public function testSaveSuccess()
{
API::getInstance()->save(
self::$fixture->idSite1,
1,
$date = '2011-04-01',
$note = 'new note text',
$starred = 1
);
$expectedAnnotation = array(
'date' => '2011-04-01',
'note' => 'new note text',
'starred' => 1,
'user' => 'superUserLogin',
'id' => 1,
'idsite' => 1,
'canEditOrDelete' => true,
'idNote' => 1,
);
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 1));
}
public function testSaveSuccessWithoutDate()
{
API::getInstance()->save(
self::$fixture->idSite1,
1,
$date = null,
$note = 'new note text',
$starred = 1
);
$expectedAnnotation = array(
'date' => '2011-04-01',
'note' => 'new note text',
'starred' => 1,
'user' => 'superUserLogin',
'id' => 1,
'idsite' => 1,
'canEditOrDelete' => true,
'idNote' => 1,
);
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 1));
}
public function testSaveSuccessChangesDateToTomorrow()
{
API::getInstance()->save(
self::$fixture->idSite1,
1,
$date = 'tomorrow',
$note = 'updated note text for tomorrow, not starred',
$starred = 0
);
$expectedAnnotation = array(
'date' => '2012-03-04',
'note' => 'updated note text for tomorrow, not starred',
'starred' => 0,
'user' => 'superUserLogin',
'id' => 1,
'idsite' => 1,
'canEditOrDelete' => true,
'idNote' => 1,
);
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 1));
}
public function testSaveNoChangesSuccess()
{
API::getInstance()->save(self::$fixture->idSite1, 3);
$expectedAnnotation = array(
'date' => '2011-12-02',
'note' => '1: Site 1 annotation for 2011-12-02',
'starred' => 0,
'user' => 'superUserLogin',
'id' => 3,
'idsite' => 1,
'canEditOrDelete' => true,
'idNote' => 3,
);
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 3));
}
public function testDeleteSuccess()
{
self::expectException(Exception::class);
API::getInstance()->delete(self::$fixture->idSite1, 1);
API::getInstance()->get(self::$fixture->idSite1, 1);
}
public function getPermissionsFailData()
{
return array(
// getAll
array(false, false, "module=API&method=Annotations.getAll&idSite=1&date=2012-01-01&period=year", true, "getAll should throw if user does not have view access"),
// get
array(false, false, "module=API&method=Annotations.get&idSite=1&idNote=1", true, "get should throw if user does not have view access"),
// getAnnotationCountForDates
array(false, false, "module=API&method=Annotations.getAnnotationCountForDates&idSite=1&date=2012-01-01&period=year", true, "getAnnotationCountForDates should throw if user does not have view access"),
// add
array(false, false, "module=API&method=Annotations.add&idSite=1&date=2011-02-01¬e=whatever", true, "add should throw if user does not have view access"),
array(false, true, "module=API&method=Annotations.add&idSite=1&date=2011-02-01¬e=whatever2", false, "add should not throw if user has view access"),
array(true, true, "module=API&method=Annotations.add&idSite=1&date=2011-02-01¬e=whatever3", false, "add should not throw if user has admin access"),
// save
array(false, false, "module=API&method=Annotations.save&idSite=1&idNote=1&date=2011-03-01¬e=newnote", true, "save should throw if user does not have view access"),
array(false, true, "module=API&method=Annotations.save&idSite=1&idNote=1&date=2011-03-01¬e=newnote", true, "save should throw if user has view access but did not edit note"),
array(true, true, "module=API&method=Annotations.save&idSite=1&idNote=53&date=2011-03-01¬e=newnote", false, "save should not throw if user has admin access"),
// delete
array(false, false, "module=API&method=Annotations.delete&idSite=1&idNote=1", true, "delete should throw if user does not have view access"),
array(false, true, "module=API&method=Annotations.delete&idSite=1&idNote=1", true, "delete should throw if user does not have view access"),
array(true, true, "module=API&method=Annotations.delete&idSite=1&idNote=53", false, "delete should not throw if user has admin access"),
);
}
/**
* @dataProvider getPermissionsFailData
*/
public function testMethodPermissions($hasAdminAccess, $hasViewAccess, $request, $checkException, $failMessage)
{
if (true === $checkException) {
self::expectException(Exception::class);
} else {
self::expectNotToPerformAssertions();
}
// create fake access that denies user access
FakeAccess::clearAccess(false);
FakeAccess::$identity = 'user' . (int)$hasAdminAccess . (int)$hasViewAccess;
FakeAccess::$idSitesAdmin = $hasAdminAccess ? array(self::$fixture->idSite1) : array();
FakeAccess::$idSitesView = $hasViewAccess ? array(self::$fixture->idSite1) : array();
$request = new Request(Request::getRequestArrayFromString($request . '&format=original'));
$request->process();
}
public static function getPathToTestDirectory()
{
return dirname(__FILE__);
}
public function provideContainerConfig()
{
return array(
'Piwik\Access' => new FakeAccess(),
);
}
}
AnnotationsTest::$fixture = new TwoSitesWithAnnotations();
|
