matomo / tests /PHPUnit /Integration /Settings /BaseSettingsTestCase.php
Leon4gr45's picture
Upload folder using huggingface_hub (part 55)
bf8c0ce verified
Raw History Blame Contribute Delete
4.71 kB
<?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\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 testConstructorShouldNotEstablishADatabaseConnection()
{
Db::destroyDatabaseObject();
$this->assertNotDbConnectionCreated();
$this->createSettingsInstance();
$this->assertNotDbConnectionCreated();
}
public function testMakeSettingShouldAlsoAddTheSetting()
{
$this->assertNull($this->settings->getSetting('myName'));
$this->makeSetting('myName');
$this->assertNotNull($this->settings->getSetting('myName'));
}
public function testMakeSettingShouldFailWhenAdingSameSettingTwice()
{
$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 testGetSettingCanRetrieveAspecificSetting()
{
$this->makeSetting('myName');
$this->assertSame('myName', $this->settings->getSetting('myName')->getName());
}
public function testGetSettingIsCaseSensitive()
{
$this->makeSetting('myName');
$this->assertNull($this->settings->getSetting('myname'));
}
public function testGetSettingReturnsNullWhenNoSuchSettingFound()
{
$this->assertNull($this->settings->getSetting('myName'));
}
public function testGetSettingsWritableByCurrentUserReturnsOnlySettingsThatAreWritable()
{
$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 testSaveTriggersAnEvent()
{
$settings = null;
Piwik::addAction($this->updateEventName, function ($instance) use (&$settings) {
$settings = $instance;
});
$this->settings->save();
$this->assertSame($settings, $this->settings);
}
public function testGetTitleShouldDefaultToPluginName()
{
$this->assertNotEmpty($this->settings->getTitle());
$this->assertSame($this->settings->getTitle(), $this->settings->getPluginName());
}
public function testGetTitlePrefersSetTitleOverPluginName()
{
if (method_exists($this->settings, 'setTitle')) {
$this->settings->setTitle('title');
$this->assertSame('title', $this->settings->getTitle());
} else {
self::expectNotToPerformAssertions();
}
}
protected function makeSetting($name)
{
$type = FieldConfig::TYPE_STRING;
return $this->settings->makeSetting($name, $default = '', $type, function () {
});
}
public function testAddSettingShouldAddNewSetting()
{
$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 testAddSettingThrowsExceptionIfSameSettingAddedTwice()
{
$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;
}
}