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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
namespace Piwik\Tests\Integration\Settings;
use Piwik\Db;
use Piwik\Piwik;
use Piwik\Settings\FieldConfig;
use Piwik\Settings\Setting;
/**
* @group PluginSettings
* @group SystemSettings
*/
class BaseSettingsTestCase extends IntegrationTestCase
{
protected $updateEventName;
public function test_constructor_shouldNotEstablishADatabaseConnection()
{
Db::destroyDatabaseObject();
$this->assertNotDbConnectionCreated();
$this->createSettingsInstance();
$this->assertNotDbConnectionCreated();
}
public function test_makeSetting_ShouldAlsoAddTheSetting()
{
$this->assertNull($this->settings->getSetting('myName'));
$this->makeSetting('myName');
$this->assertNotNull($this->settings->getSetting('myName'));
}
public function test_makeSetting_ShouldFailWhenAdingSameSettingTwice()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('A setting with name "myName" does already exist for plugin "ExampleSettingsPlugin"');
$this->makeSetting('myName');
$this->makeSetting('myName');
}
public function test_getSetting_CanRetrieveAspecificSetting()
{
$this->makeSetting('myName');
$this->assertSame('myName', $this->settings->getSetting('myName')->getName());
}
public function test_getSetting_IsCaseSensitive()
{
$this->makeSetting('myName');
$this->assertNull($this->settings->getSetting('myname'));
}
public function test_getSetting_ReturnsNullWhenNoSuchSettingFound()
{
$this->assertNull($this->settings->getSetting('myName'));
}
public function test_getSettingsWritableByCurrentUser_returnsOnlySettingsThatAreWritable()
{
$this->assertSame(array(), $this->settings->getSettingsWritableByCurrentUser());
$setting1 = $this->makeSetting('myName1');
$setting1->setIsWritableByCurrentUser(true);
$setting2 = $this->makeSetting('myName2');
$setting2->setIsWritableByCurrentUser(false);
$setting3 = $this->makeSetting('myName3');
$setting3->setIsWritableByCurrentUser(true);
$expected = array(
'myName1' => $setting1,
'myName3' => $setting3
);
$this->assertSame($expected, $this->settings->getSettingsWritableByCurrentUser());
}
public function test_save_triggersAnEvent()
{
$settings = null;
Piwik::addAction($this->updateEventName, function ($instance) use (&$settings) {
$settings = $instance;
});
$this->settings->save();
$this->assertSame($settings, $this->settings);
}
public function test_getTitle_shouldDefaultToPluginName()
{
$this->assertNotEmpty($this->settings->getTitle());
$this->assertSame($this->settings->getTitle(), $this->settings->getPluginName());
}
public function test_getTitle_PrefersSetTitleOverPluginName()
{
if (method_exists($this->settings, 'setTitle')) {
$this->settings->setTitle('title');
$this->assertSame('title', $this->settings->getTitle());
}
}
protected function makeSetting($name)
{
$type = FieldConfig::TYPE_STRING;
return $this->settings->makeSetting($name, $default = '', $type, function () {});
}
public function test_addSetting_shouldAddNewSetting()
{
$settingName = 'testSetting';
$setting = $this->buildSetting($settingName);
$settings = $this->createSettingsInstance();
$this->assertEmpty($settings->getSetting($settingName));
$settings->addSetting($setting);
$this->assertSame($setting, $settings->getSetting($settingName));
}
public function test_addSetting_throwsException_IfSameSettingAddedTwice()
{
$this->expectException(\Exception::class);
$this->expectExceptionMessage('"testSetting" does already exist');
$settingName = 'testSetting';
$setting = $this->buildSetting($settingName);
$settings = $this->createSettingsInstance();
$settings->addSetting($setting);
$settings->addSetting($setting);
}
private function buildSetting($name, $type = null, $default = '')
{
if (!isset($type)) {
$type = FieldConfig::TYPE_STRING;
}
$userSetting = new Setting($name, $default, $type, 'MyPluginName');
return $userSetting;
}
}
|