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
|
<?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\CorePluginsAdmin\tests\Integration;
use Piwik\Access;
use Piwik\Auth;
use Piwik\Container\StaticContainer;
use Piwik\Plugins\CorePluginsAdmin\SettingsMetadata;
use Piwik\Plugins\CorePluginsAdmin\tests\Fixtures\PluginUpdatesFixture;
use Piwik\Plugins\CoreUpdater\SystemSettings;
use Piwik\Plugins\UsersManager\API;
use Piwik\Tests\Framework\Fixture;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
class ApiTest extends IntegrationTestCase
{
public const TEST_USER = 'atestuser';
public const TEST_PASSWORD = 'testpassword';
/**
* @var PluginUpdatesFixture
*/
public static $fixture;
private $testSystemSettingsPayload = [
'CoreUpdater' => [
['name' => 'release_channel', 'value' => 'latest_beta'],
],
];
private $testSystemSettingsEmptyValuePayload = [
'ExampleSettingsPlugin' => [
['name' => 'browsers', 'value' => '__empty__'],
],
];
protected static function beforeTableDataCached()
{
parent::beforeTableDataCached();
API::getInstance()->addUser(self::TEST_USER, self::TEST_PASSWORD, 'someuser@email.com');
API::getInstance()->setSuperUserAccess(self::TEST_USER, true, Fixture::ADMIN_USER_PASSWORD);
}
public function setUp(): void
{
parent::setUp();
Access::getInstance()->setSuperUserAccess(false);
$auth = StaticContainer::get(Auth::class);
$auth->setLogin(self::TEST_USER);
$auth->setPassword(self::TEST_PASSWORD);
Access::getInstance()->reloadAccess($auth);
}
public function testSetSystemSettingsThrowsIfNoPasswordConfirmation()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('UsersManager_ConfirmWithReAuthentication');
$settingValues = $this->testSystemSettingsPayload;
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues);
}
public function testSetSystemSettingsThrowsIfPasswordConfirmationWrong()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('UsersManager_CurrentPasswordNotCorrect');
$settingValues = $this->testSystemSettingsPayload;
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues, 'blahblah');
}
public function testSetSystemSettingsCorrectlySetsSettings()
{
$settingValues = $this->testSystemSettingsPayload;
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues, self::TEST_PASSWORD);
$coreUpdaterSettings = StaticContainer::get(SystemSettings::class);
$value = $coreUpdaterSettings->releaseChannel->getValue();
$this->assertEquals('latest_beta', $value);
}
public function testGetSystemSettingsRedactsPasswordValues()
{
$pluginSettings = StaticContainer::get(\Piwik\Plugins\ExampleSettingsPlugin\SystemSettings::class);
$settings = $this->getPluginSettings('ExampleSettingsPlugin', 'password');
self::assertEquals('password', $settings['name']);
self::assertEquals('', $settings['value']);
self::assertEquals('', $pluginSettings->getSetting('password')->getValue());
$settingValues = [
'ExampleSettingsPlugin' => [
['name' => 'password', 'value' => 'newPassword'],
],
];
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues, self::TEST_PASSWORD);
$newSettings = $this->getPluginSettings('ExampleSettingsPlugin', 'password');
self::assertEquals('password', $newSettings['name']);
self::assertEquals(SettingsMetadata::PASSWORD_PLACEHOLDER, $newSettings['value']); // API returns value redacted
self::assertTrue(password_verify('newPassword', $pluginSettings->getSetting('password')->getValue()));
// check that sending the placeholder as value doesn't update the setting
$settingValues = [
'ExampleSettingsPlugin' => [
['name' => 'password', 'value' => SettingsMetadata::PASSWORD_PLACEHOLDER],
],
];
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues, self::TEST_PASSWORD);
$newSettings = $this->getPluginSettings('ExampleSettingsPlugin', 'password');
self::assertEquals('password', $newSettings['name']);
self::assertEquals(SettingsMetadata::PASSWORD_PLACEHOLDER, $newSettings['value']); // API returns value redacted
self::assertTrue(password_verify('newPassword', $pluginSettings->getSetting('password')->getValue()));
}
public function testSetSystemSettingsCorrectlySetsEmptyValue()
{
$pluginSettings = StaticContainer::get(\Piwik\Plugins\ExampleSettingsPlugin\SystemSettings::class);
$settings = $this->getPluginSettings('ExampleSettingsPlugin', 'browsers');
$defaultValue = ['firefox', 'chromium', 'safari'];
self::assertEquals('browsers', $settings['name']);
self::assertEquals($defaultValue, $settings['value']);
self::assertEquals($defaultValue, $pluginSettings->getSetting('browsers')->getValue());
$settingValues = $this->testSystemSettingsEmptyValuePayload;
\Piwik\Plugins\CorePluginsAdmin\API::getInstance()->setSystemSettings($settingValues, self::TEST_PASSWORD);
$newSettings = $this->getPluginSettings('ExampleSettingsPlugin', 'browsers');
self::assertEquals('browsers', $newSettings['name']);
self::assertEquals([], $newSettings['value']);
self::assertEquals([], $pluginSettings->getSetting('browsers')->getValue());
}
public function testGetNumberOfPluginUpdates()
{
$updates = \Piwik\Plugins\CorePluginsAdmin\API::getInstance()->getNumberOfPluginUpdates();
self::assertEquals(2, $updates);
}
private function getPluginSettings(string $pluginName, string $settingName): array
{
$settings = \Piwik\Plugins\CorePluginsAdmin\API::getInstance()->getSystemSettings();
foreach ($settings as $pluginSettings) {
if ($pluginSettings['pluginName'] === $pluginName) {
foreach ($pluginSettings['settings'] as $pSetting) {
if ($pSetting['name'] === $settingName) {
return $pSetting;
}
}
}
}
return [];
}
protected static function configureFixture($fixture)
{
parent::configureFixture($fixture);
$fixture->createSuperUser = true;
}
}
ApiTest::$fixture = new PluginUpdatesFixture();
|
