File: BackendTest.php

package info (click to toggle)
matomo-component-cache 2.0.6-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 396 kB
  • sloc: php: 1,433; makefile: 12
file content (222 lines) | stat: -rw-r--r-- 6,097 bytes parent folder | download
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
<?php
/**
 * Matomo - free/libre analytics platform
 *
 * @link https://matomo.org
 * @license http://www.gnu.org/licenses/lgpl-3.0.html LGPL v3 or later
 */

namespace Tests\Matomo\Cache;

use Matomo\Cache\Backend;
use Matomo\Cache\Backend\ArrayCache;
use Matomo\Cache\Backend\Chained;
use Matomo\Cache\Backend\Factory;
use Matomo\Cache\Backend\File;
use PHPUnit\Framework\TestCase;

class BackendTest extends TestCase
{

    private $cacheId = 'testid';
    private $cacheValue = 'exampleValue';

    private static $backends = array();

    protected function setUp()
    {
        foreach (self::$backends as $backend) {
            /** @var Backend[] $backend */
            $backend[0]->doFlush();
            $success = $backend[0]->doSave($this->cacheId, $this->cacheValue);
            $this->assertTrue($success);
        }
    }

    public static function tearDownAfterClass()
    {
        foreach (self::$backends as $backend) {
            /** @var Backend[] $backend */
            $backend[0]->doFlush();
        }

        self::$backends = array();
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doFetch_shouldReturnFalse_IfNoSuchCacheIdExists(Backend $backend)
    {
        $this->assertFalse($backend->doFetch('randomid'));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doFetch_shouldReturnTheCachedValue_IfCacheIdExists(Backend $backend)
    {
        $this->assertEquals($this->cacheValue, $backend->doFetch($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doContains_shouldReturnFalse_IfNoSuchCacheIdExists(Backend $backend)
    {
        $this->assertFalse($backend->doContains('randomid'));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doContains_shouldReturnTrue_IfCacheIdExists(Backend $backend)
    {
        $this->assertTrue($backend->doContains($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doDelete_shouldReturnTrue_OnSuccess(Backend $backend)
    {
        $this->assertTrue($backend->doDelete($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doDelete_shouldActuallyDeleteCacheId(Backend $backend)
    {
        $this->assertHasCacheEntry($backend, $this->cacheId);

        $backend->doDelete($this->cacheId);

        $this->assertHasNotCacheEntry($backend, $this->cacheId);
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doDelete_shouldNotDeleteAnyOtherCacheIds(Backend $backend)
    {
        $backend->doSave('anyother', 'myvalue');
        $this->assertHasCacheEntry($backend, $this->cacheId);

        $backend->doDelete($this->cacheId);

        $this->assertHasCacheEntry($backend, 'anyother');
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doDelete_shouldNotFail_IfCacheEntryDoesNotExist(Backend $backend)
    {
        $success = $backend->doDelete('anYRandoOmId');

        $this->assertTrue($success);
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doSave_shouldOverwriteAnyValue_IfCacheIdAlreadyExists(Backend $backend)
    {
        $this->assertHasCacheEntry($backend, $this->cacheId);

        $value = 'anyotherValuE';
        $backend->doSave($this->cacheId, $value);

        $this->assertSame($value, $backend->doFetch($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doSave_shouldBeAbleToSetArrays(Backend $backend)
    {
        $value = array('anyotherE' => 'anyOtherValUE', 1 => array(2));
        $backend->doSave($this->cacheId, $value);

        $this->assertSame($value, $backend->doFetch($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doSave_shouldBeAbleToSetNumbers(Backend $backend)
    {
        $value = 5.4;
        $backend->doSave($this->cacheId, $value);

        $this->assertSame($value, $backend->doFetch($this->cacheId));
    }

    /**
     * @dataProvider getBackends
     */
    public function test_doFlush_shouldRemoveAllCacheIds(Backend $backend)
    {
        $this->assertHasCacheEntry($backend, $this->cacheId);
        $backend->doSave('mykey', 'myvalue');
        $this->assertHasCacheEntry($backend, 'mykey');

        $backend->doFlush();

        $this->assertHasNotCacheEntry($backend, $this->cacheId);
        $this->assertHasNotCacheEntry($backend, 'mykey');
    }

    public function getBackends()
    {
        if (!empty(self::$backends)) {
            return self::$backends;
        }

        /** @var Backend[] $backends */
        $backends = array();

        $arrayCache = new ArrayCache();
        $fileCache  = new File($this->getPathToCacheDir());

        $chainedFileCache = new File( $this->getPathToCacheDir() . '/chain' );
        $chainCache = new Chained( array(new ArrayCache(), $chainedFileCache) );

        $timeoutDecorated = new Backend\DefaultTimeoutDecorated( new ArrayCache(), ['defaultTimeout' => 8866] );
        $prefixDecorated = new Backend\KeyPrefixDecorated( new ArrayCache(), ['keyPrefix' => 'prefix123'] );

        $backends[] = $arrayCache;
        $backends[] = $fileCache;
        $backends[] = $chainCache;
        $backends[] = $timeoutDecorated;
        $backends[] = $prefixDecorated;

        if (extension_loaded('redis')) {
            $factory = new Factory();
            $backends[] = $factory->buildRedisCache(array('host' => '127.0.0.1', 'port' => '6379'));
        }

        foreach ($backends as $backend) {
            self::$backends[] = array($backend);
        }

        return self::$backends;
    }

    private function getPathToCacheDir()
    {
        return __DIR__ . '/tmp';
    }

    private function assertHasCacheEntry(Backend $backend, $cacheId)
    {
        $this->assertTrue($backend->doContains($cacheId));
    }

    private function assertHasNotCacheEntry(Backend $backend, $cacheId)
    {
        $this->assertFalse($backend->doContains($cacheId));
    }

}