Newer
Older
benakamoorthi
a validé
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
use Piwik\API\Request;
mattab
a validé
use Piwik\Plugins\Annotations\API;
benakamoorthi
a validé
class AnnotationsTest extends IntegrationTestCase
{
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
public static $fixture = null;
public function getOutputPrefix()
{
return 'annotations';
}
public function getApiForTesting()
{
$idSite1 = self::$fixture->idSite1;
$idSite2 = self::$fixture->idSite2;
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-15,2012-02-15',
'periods' => array('range'),
'otherRequestParameters' => array('lastN' => 6),
'testSuffix' => '_range')),
array('Annotations.getAll', array('idSite' => 'all',
'date' => '2012-01-01',
'periods' => array('month'),
'testSuffix' => '_multipleSites')),
// 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' => 'all',
'date' => '2012-01-01',
'periods' => array('month'),
'testSuffix' => '_multipleSites')),
);
}
/**
* @dataProvider getApiForTesting
* @group Integration
* @group Annotations
*/
public function testApi($api, $params)
{
$this->runApiTests($api, $params);
}
/**
* @group Integration
* @group Annotations
*/
public function testAddMultipleSitesFail()
{
try {
mattab
a validé
API::getInstance()->add("1,2,3", "2012-01-01", "whatever");
$this->fail("add should fail when given multiple sites in idSite");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testAddInvalidDateFail()
{
try {
mattab
a validé
API::getInstance()->add(self::$fixture->idSite1, "invaliddate", "whatever");
$this->fail("add should fail when given invalid date");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testSaveMultipleSitesFail()
{
try {
mattab
a validé
API::getInstance()->save("1,2,3", 0);
$this->fail("save should fail when given multiple sites");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testSaveInvalidDateFail()
{
try {
mattab
a validé
API::getInstance()->save(self::$fixture->idSite1, 0, "invaliddate");
$this->fail("save should fail when given an invalid date");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testSaveInvalidNoteIdFail()
{
try {
mattab
a validé
API::getInstance()->save(self::$fixture->idSite1, -1);
$this->fail("save should fail when given an invalid note id");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testDeleteMultipleSitesFail()
{
try {
mattab
a validé
API::getInstance()->delete("1,2,3", 0);
$this->fail("delete should fail when given multiple site IDs");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testDeleteInvalidNoteIdFail()
{
try {
mattab
a validé
API::getInstance()->delete(self::$fixture->idSite1, -1);
$this->fail("delete should fail when given an invalid site ID");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testGetMultipleSitesFail()
{
try {
mattab
a validé
API::getInstance()->get("1,2,3", 0);
$this->fail("get should fail when given multiple site IDs");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testGetInvalidNoteIdFail()
{
try {
mattab
a validé
API::getInstance()->get(self::$fixture->idSite1, -1);
$this->fail("get should fail when given an invalid note ID");
} catch (Exception $ex) {
// pass
}
}
/**
* @group Integration
* @group Annotations
*/
public function testSaveSuccess()
{
mattab
a validé
API::getInstance()->save(
self::$fixture->idSite1, 0, $date = '2011-04-01', $note = 'new note text', $starred = 1);
$expectedAnnotation = array(
'date' => '2011-04-01',
'note' => 'new note text',
'starred' => 1,
'user' => 'superUserLogin',
'idNote' => 0,
'canEditOrDelete' => true
);
mattab
a validé
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 0));
}
/**
* @group Integration
* @group Annotations
*/
public function testSaveNoChangesSuccess()
{
mattab
a validé
API::getInstance()->save(self::$fixture->idSite1, 1);
$expectedAnnotation = array(
'date' => '2011-12-02',
'note' => '1: Site 1 annotation for 2011-12-02',
'starred' => 0,
'user' => 'superUserLogin',
'idNote' => 1,
'canEditOrDelete' => true
);
mattab
a validé
$this->assertEquals($expectedAnnotation, API::getInstance()->get(self::$fixture->idSite1, 1));
}
/**
* @group Integration
* @group Annotations
*/
public function testDeleteSuccess()
{
mattab
a validé
API::getInstance()->delete(self::$fixture->idSite1, 1);
try {
mattab
a validé
API::getInstance()->get(self::$fixture->idSite1, 1);
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
$this->fail("failed to delete annotation");
} catch (Exception $ex) {
// pass
}
}
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=0", 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=0&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=0&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=0&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=0", true, "delete should throw if user does not have view access"),
array(false, true, "module=API&method=Annotations.delete&idSite=1&idNote=0", true, "delete should throw if user does not have view access"),
array(true, true, "module=API&method=Annotations.delete&idSite=1&idNote=0", false, "delete should not throw if user has admin access"),
);
}
/**
* @dataProvider getPermissionsFailData
* @group Integration
* @group Annotations
*/
public function testMethodPermissions($hasAdminAccess, $hasViewAccess, $request, $checkException, $failMessage)
{
// create fake access that denies user access
$access = new FakeAccess();
FakeAccess::$superUser = false;
FakeAccess::$idSitesAdmin = $hasAdminAccess ? array(self::$fixture->idSite1) : array();
FakeAccess::$idSitesView = $hasViewAccess ? array(self::$fixture->idSite1) : array();
Access::setSingletonInstance($access);
if ($checkException) {
try {
$request = new Request($request);
$request->process();
$this->fail($failMessage);
} catch (Exception $ex) {
// pass
}
} else {
$request = new Request($request);
$request->process();
}
}
benakamoorthi
a validé
}
diosmosis
a validé
AnnotationsTest::$fixture = new Test_Piwik_Fixture_TwoSitesWithAnnotations();