File size: 4,597 Bytes
bf8c0ce
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
<?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\Storage;

use Piwik\Settings\FieldConfig;
use Piwik\Settings\Storage\Backend\BackendInterface;
use Piwik\Settings\Storage\Storage;
use Piwik\Tests\Framework\Mock\Settings\FakeBackend;
use Piwik\Tests\Framework\TestCase\IntegrationTestCase;
use Piwik\Tracker\Cache as TrackerCache;

/**
 * @group PluginSettings
 * @group Storage
 */
class StorageTest extends IntegrationTestCase
{
    /**
     * @var Storage
     */
    protected $storage;

    /**
     * @var BackendInterface
     */
    protected $backend;

    /**
     * @var string
     */
    protected $settingName = 'myname';

    public function setUp(): void
    {
        parent::setUp();

        $this->backend = new FakeBackend('MyTestId');
        $this->backend->save(array($this->settingName => 'value1'));
        $this->storage = $this->buildStorage();
    }

    public function testGetBackend()
    {
        $this->assertSame($this->backend, $this->storage->getBackend());
    }

    public function testGetValueShouldReturnDefaultValueIfNoValueIsSet()
    {
        $value = $this->storage->getValue('UnkNownFielD', $default = '123', FieldConfig::TYPE_STRING);
        $this->assertSame($default, $value);
    }

    public function testGetValueShouldReturnDefaultValueAndNotCastDefaultValue()
    {
        $value = $this->storage->getValue('UnkNownFielD', $default = '123', FieldConfig::TYPE_INT);
        $this->assertSame($default, $value);
    }

    public function testGetValueShouldReturnASavedValueFromBackend()
    {
        $value = $this->getValueFromStorage($this->settingName);
        $this->assertSame('value1', $value);
    }

    public function testSetValueGetValueShouldSetAndGetActualValue()
    {
        $this->storage->setValue($this->settingName, 'myRandomVal');
        $value = $this->getValueFromStorage($this->settingName);
        $this->assertEquals('myRandomVal', $value);
    }

    public function testSetValueGetValueShouldCastValueWhenGettingTheValue()
    {
        $this->storage->setValue($this->settingName, '1');
        $value = $this->getValueFromStorage($this->settingName, FieldConfig::TYPE_BOOL);
        $this->assertTrue($value);
    }

    public function testSetValueShouldNotSaveItInDatabase()
    {
        $loaded = $this->backend->load();
        $this->storage->setValue($this->settingName, 'myRandomVal');

        $this->assertSame($loaded, $this->loadValuesFromBackend());
    }

    public function testSaveShouldPersistValueInDatabase()
    {
        $this->storage->setValue($this->settingName, 'myRandomVal');
        $this->storage->save();

        $this->assertEquals(
            array($this->settingName => 'myRandomVal'),
            $this->loadValuesFromBackend()
        );
    }

    public function testSaveShouldPersistMultipleValuesContainingInt()
    {
        $this->storage->setValue($this->settingName, 'myRandomVal');
        $this->storage->setValue('mySecondName', 5);
        $this->storage->save();

        $this->assertEquals(
            array($this->settingName => 'myRandomVal', 'mySecondName' => 5),
            $this->loadValuesFromBackend()
        );
    }

    public function testSaveShouldNotClearTrackerCacheEntriesIfThereWasNoChange()
    {
        TrackerCache::setCacheGeneral(array('testSetting' => 1));

        $this->assertArrayHasKey('testSetting', TrackerCache::getCacheGeneral());

        $this->storage->save();

        $this->assertArrayHasKey('testSetting', TrackerCache::getCacheGeneral());
    }

    public function testSaveShouldClearTrackerCacheEntriesIfThereWasActuallyAChange()
    {
        TrackerCache::setCacheGeneral(array('testSetting' => 1));

        $this->assertArrayHasKey('testSetting', TrackerCache::getCacheGeneral());

        $this->storage->setValue('myTest', 5); // it will save only when there was actually a change
        $this->storage->save();

        $this->assertArrayNotHasKey('testSetting', TrackerCache::getCacheGeneral());
    }

    private function getValueFromStorage($settingName, $type = null)
    {
        if (!isset($type)) {
            $type = FieldConfig::TYPE_STRING;
        }
        return $this->storage->getValue($settingName, $default = '', $type);
    }

    protected function buildStorage()
    {
        return new Storage($this->backend);
    }

    protected function loadValuesFromBackend()
    {
        return $this->backend->load();
    }
}