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
|
<?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\UsersManager\tests\Integration;
use Piwik\Config;
use Piwik\Piwik;
use Piwik\Plugins\UsersManager\UserPreferences;
use Piwik\Plugins\UsersManager\API as APIUsersManager;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\Mock\FakeAccess;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
/**
* @group UsersManager
* @group UserPreferencesTest
* @group Plugins
* @group Plugins
*/
class UserPreferencesTest extends IntegrationTestCase
{
/**
* @var UserPreferences
*/
private $userPreferences;
public function setUp(): void
{
parent::setUp();
$this->userPreferences = new UserPreferences();
$this->setSuperUser();
$identity = FakeAccess::$identity;
FakeAccess::$identity = 'foo'; // avoids error user already exists when it doesn't
APIUsersManager::getInstance()->addUser($identity, '22111214k4,mdw<L', 'foo@example.com');
FakeAccess::$identity = $identity;
}
public function testGetDefaultReportWhenLoginNotExists()
{
self::expectException(\Exception::class);
self::expectExceptionMessage('User does not exist');
APIUsersManager::getInstance()->setUserPreference(
'foo',
APIUsersManager::PREFERENCE_DEFAULT_REPORT,
'1'
);
}
public function testGetDefaultReportWhenWrongPreference()
{
self::expectException(\Exception::class);
self::expectExceptionMessage('Not supported preference name');
APIUsersManager::getInstance()->setUserPreference(
Piwik::getCurrentUserLogin(),
'foo',
'1'
);
}
public function testGetDefaultReportShouldReturnFalseByDefault()
{
$this->assertEquals(false, $this->userPreferences->getDefaultReport());
}
public function testGetDefaultReportShouldReturnTheRawValueIfNotNumeric()
{
$this->setDefaultReport('MultiSites');
$this->assertEquals('MultiSites', $this->userPreferences->getDefaultReport());
}
public function testGetDefaultReportShouldNotReturnSiteIdIfNoPermissionForSite()
{
$this->createSite();
$this->setDefaultReport(1);
$this->setAnonymous();
$this->assertEquals(false, $this->userPreferences->getDefaultReport());
}
public function testGetDefaultReportShouldReturnSiteIdIfPermissionForSite()
{
$this->createSite();
$this->setDefaultReport(1);
$this->assertEquals(1, $this->userPreferences->getDefaultReport());
}
public function testGetDefaultWebsiteIdShouldReturnFalseByDefault()
{
$this->assertEquals(false, $this->userPreferences->getDefaultWebsiteId());
}
public function testGetDefaultWebsiteIdShouldReturnASiteIfOneExistsAndHasAccess()
{
$this->createSite();
$this->assertEquals(1, $this->userPreferences->getDefaultWebsiteId());
}
public function testGetDefaultWebsiteIdShouldReturnFalseIfASiteExistsButHasNoAccess()
{
$this->createSite();
$this->setAnonymous();
$this->assertEquals(false, $this->userPreferences->getDefaultWebsiteId());
}
public function testGetDefaultWebsiteIdShouldReturnASiteEvenIfMultiSitesIsDefaultReport()
{
$this->setDefaultReport('MultiSites');
$this->createSite();
$this->assertEquals(1, $this->userPreferences->getDefaultWebsiteId());
}
/**
* @dataProvider provideDefaultDates
*/
public function testGetDefaultDateAndPeriod($defaultDate, $expectedDate, $expectedPeriod)
{
$this->setDefaultDate($defaultDate);
$this->assertEquals($expectedDate, $this->userPreferences->getDefaultDate());
$this->assertEquals($expectedPeriod, $this->userPreferences->getDefaultPeriod());
}
public function provideDefaultDates()
{
return array(
'today' => array('today', 'today', 'day'),
'yesterday' => array('yesterday', 'yesterday', 'day'),
'month' => array('month', 'today', 'month'),
'week' => array('week', 'today', 'week'),
'last7' => array('last7', 'last7', 'range'),
'last30' => array('last30', 'last30', 'range'),
);
}
public function testGetDefaultPeriodShouldOnlyReturnAllowedPeriods()
{
// Only allow for week period
Config::getInstance()->General['enabled_periods_UI'] = 'week';
Config::getInstance()->General['default_period'] = 'week';
Config::getInstance()->General['default_day'] = 'yesterday';
$this->setDefaultDate('today');
// Should be system defaults
$this->assertEquals('week', $this->userPreferences->getDefaultPeriod());
$this->assertEquals('yesterday', $this->userPreferences->getDefaultDate());
}
public function testGetDefaultDateShouldOnlyReturnDateInAllowedPeriods()
{
// Only allow for week period
Config::getInstance()->General['enabled_periods_UI'] = 'day';
Config::getInstance()->General['default_period'] = 'day';
$this->setDefaultDate('last7');
$this->assertEquals('yesterday', $this->userPreferences->getDefaultDate());
}
private function setSuperUser()
{
FakeAccess::$superUser = true;
}
private function setAnonymous()
{
FakeAccess::clearAccess();
}
private function createSite()
{
Fixture::createWebsite('2013-01-23 01:23:45');
}
private function setDefaultReport($defaultReport)
{
APIUsersManager::getInstance()->setUserPreference(
Piwik::getCurrentUserLogin(),
APIUsersManager::PREFERENCE_DEFAULT_REPORT,
$defaultReport
);
}
private function setDefaultDate($date)
{
APIUsersManager::getInstance()->setUserPreference(
Piwik::getCurrentUserLogin(),
APIUsersManager::PREFERENCE_DEFAULT_REPORT_DATE,
$date
);
}
public function provideContainerConfig()
{
return array(
'Piwik\Access' => new FakeAccess(),
);
}
}
|
