ApcuCacheTest::testReloadOnMissHonorsLock() - Code Metrics - Inspection of "Add ability to use APCu for translation cache" - phpmyadmin/motranslator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#42)

unknown

created 2022-03-03 18:07 UTC

ApcuCacheTest::testReloadOnMissHonorsLock() A

↳ Parent: ApcuCacheTest

Complexity

Conditions	1
Paths	1

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
cc	1
eloc	13
c	2
b	0
f	0
nc	1
nop	0
dl	0
loc	21
rs	9.8333

<?php

declare(strict_types=1);

namespace PhpMyAdmin\MoTranslator\Tests\Cache;

use PhpMyAdmin\MoTranslator\Cache\ApcuCache;
use PhpMyAdmin\MoTranslator\MoParser;
use PHPUnit\Framework\TestCase;
use ReflectionMethod;

use function apcu_clear_cache;
use function apcu_delete;
use function apcu_enabled;
use function apcu_entry;
use function apcu_fetch;
use function chr;
use function explode;
use function function_exists;
use function implode;
use function sleep;

/**
 * @covers \PhpMyAdmin\MoTranslator\Cache\ApcuCache
 */
class ApcuCacheTest extends TestCase
{
    protected function setUp(): void
    {
        parent::setUp();

        if (function_exists('apcu_enabled') && apcu_enabled()) {
            return;
        }

        $this->markTestSkipped('ACPu extension is not installed and enabled for CLI');
    }

    protected function tearDown(): void
    {
        parent::tearDown();

        apcu_clear_cache();
    }

    public function testConstructorLoadsCache(): void
    {
        $expected = 'Pole';
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';

        new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);

        $actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid);
        $this->assertSame($expected, $actual);
    }

    public function testConstructorSetsTtl(): void
    {
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';
        $ttl = 1;

        new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain, $ttl);
        sleep($ttl * 2);

        apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid, $success);
        $this->assertFalse($success);
        apcu_fetch('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY, $success);
        $this->assertFalse($success);
    }

    public function testConstructorSetsReloadOnMiss(): void
    {
        $expected = 'Column';
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';
        $prefix = 'baz_';

        $cache = new ApcuCache(
            new MoParser(__DIR__ . '/../data/little.mo'),
            $locale,
            $domain,
            0,
            false,
            $prefix
        );

        apcu_delete($prefix . $locale . '.' . $domain . '.' . $msgid);
        $actual = $cache->get($msgid);
        $this->assertEquals($expected, $actual);
    }

    public function testConstructorSetsPrefix(): void
    {
        $expected = 'Pole';
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';
        $prefix = 'baz_';

        new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain, 0, true, $prefix);

        $actual = apcu_fetch($prefix . $locale . '.' . $domain . '.' . $msgid);
        $this->assertSame($expected, $actual);
    }

    public function testEnsureTranslationsLoadedSetsLoadedKey(): void
    {
        $expected = 1;
        $locale = 'foo';
        $domain = 'bar';

        new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);

        $actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY);
        $this->assertSame($expected, $actual);
    }

    public function testEnsureTranslationsLoadedHonorsLock(): void
    {
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';

        $lock = 'mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY;
        apcu_entry($lock, static function () {
            sleep(1);

            return 1;
        });

        new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);

        $actual = apcu_fetch($lock);
        $this->assertSame(1, $actual);
        apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid, $success);
        $this->assertFalse($success);
    }

    public function testGetReturnsMsgstr(): void
    {
        $expected = 'Pole';
        $msgid = 'Column';

        $cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), 'foo', 'bar');

        $actual = $cache->get($msgid);
        $this->assertSame($expected, $actual);
    }

    public function testGetReturnsMsgidForCacheMiss(): void
    {
        $expected = 'Column';

        $cache = new ApcuCache(new MoParser(null), 'foo', 'bar');

        $actual = $cache->get($expected);
        $this->assertSame($expected, $actual);
    }

    public function testStoresMsgidOnCacheMiss(): void
    {
        $expected = 'Column';
        $locale = 'foo';
        $domain = 'bar';

        $cache = new ApcuCache(new MoParser(null), $locale, $domain);
        $cache->get($expected);

        $actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $expected);
        $this->assertSame($expected, $actual);
    }

    public function testGetReloadsOnCacheMiss(): void
    {
        $expected = 'Pole';
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';

        $cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);

        apcu_delete('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY);
        $actual = $cache->get($msgid);
        $this->assertSame($expected, $actual);
    }

    public function testReloadOnMissHonorsLock(): void
    {
        $expected = 'Pole';
        $locale = 'foo';
        $domain = 'bar';
        $msgid = 'Column';

        $cache = new ApcuCache(new MoParser(null), $locale, $domain);

        $method = new ReflectionMethod($cache, 'reloadOnMiss');
        $method->setAccessible(true);

        $key = 'mo_' . $locale . '.' . $domain . '.' . $msgid;
        apcu_entry($key, static function () use ($expected): string {
            sleep(1);

            return $expected;
        });
        $actual = $method->invoke($cache, $msgid);

        $this->assertSame($expected, $actual);
    }

    public function testSetSetsMsgstr(): void
    {
        $expected = 'Pole';
        $msgid = 'Column';

        $cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
        $cache->set($msgid, $expected);

        $actual = $cache->get($msgid);
        $this->assertSame($expected, $actual);
    }

    public function testHasReturnsFalse(): void
    {
        $cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
        $actual = $cache->has('Column');
        $this->assertFalse($actual);
    }

    public function testHasReturnsTrue(): void
    {
        $cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), 'foo', 'bar');
        $actual = $cache->has('Column');
        $this->assertTrue($actual);
    }

    public function testSetAllSetsTranslations(): void
    {
        $translations = [
            'foo' => 'bar',
            'and' => 'another',
        ];

        $cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
        $cache->setAll($translations);

        foreach ($translations as $msgid => $expected) {
            $actual = $cache->get($msgid);
            $this->assertEquals($expected, $actual);
        }
    }

    public function testCacheStoresPluralForms(): void
    {
        $expected = ['first', 'second'];
        $plural = ["%d pig went to the market\n", "%d pigs went to the market\n"];
        $msgid = implode(chr(0), $plural);

        $cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
        $cache->set($msgid, implode(chr(0), $expected));

        $msgstr = $cache->get($msgid);
        $actual = explode(chr(0), $msgstr);
        $this->assertSame($expected, $actual);
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace PhpMyAdmin\MoTranslator\Tests\Cache;
6
7			use PhpMyAdmin\MoTranslator\Cache\ApcuCache;
8			use PhpMyAdmin\MoTranslator\MoParser;
9			use PHPUnit\Framework\TestCase;
10			use ReflectionMethod;
11
12			use function apcu_clear_cache;
13			use function apcu_delete;
14			use function apcu_enabled;
15			use function apcu_entry;
16			use function apcu_fetch;
17			use function chr;
18			use function explode;
19			use function function_exists;
20			use function implode;
21			use function sleep;
22
23			/**
24			* @covers \PhpMyAdmin\MoTranslator\Cache\ApcuCache
25			*/
26			class ApcuCacheTest extends TestCase
27			{
28			protected function setUp(): void
29			{
30			parent::setUp();
31
32			if (function_exists('apcu_enabled') && apcu_enabled()) {
33			return;
34			}
35
36			$this->markTestSkipped('ACPu extension is not installed and enabled for CLI');
37			}
38
39			protected function tearDown(): void
40			{
41			parent::tearDown();
42
43			apcu_clear_cache();
44			}
45
46			public function testConstructorLoadsCache(): void
47			{
48			$expected = 'Pole';
49			$locale = 'foo';
50			$domain = 'bar';
51			$msgid = 'Column';
52
53			new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);
54
55			$actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid);
56			$this->assertSame($expected, $actual);
57			}
58
59			public function testConstructorSetsTtl(): void
60			{
61			$locale = 'foo';
62			$domain = 'bar';
63			$msgid = 'Column';
64			$ttl = 1;
65
66			new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain, $ttl);
67			sleep($ttl * 2);
68
69			apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid, $success);
70			$this->assertFalse($success);
71			apcu_fetch('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY, $success);
72			$this->assertFalse($success);
73			}
74
75			public function testConstructorSetsReloadOnMiss(): void
76			{
77			$expected = 'Column';
78			$locale = 'foo';
79			$domain = 'bar';
80			$msgid = 'Column';
81			$prefix = 'baz_';
82
83			$cache = new ApcuCache(
84			new MoParser(__DIR__ . '/../data/little.mo'),
85			$locale,
86			$domain,
87			0,
88			false,
89			$prefix
90			);
91
92			apcu_delete($prefix . $locale . '.' . $domain . '.' . $msgid);
93			$actual = $cache->get($msgid);
94			$this->assertEquals($expected, $actual);
95			}
96
97			public function testConstructorSetsPrefix(): void
98			{
99			$expected = 'Pole';
100			$locale = 'foo';
101			$domain = 'bar';
102			$msgid = 'Column';
103			$prefix = 'baz_';
104
105			new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain, 0, true, $prefix);
106
107			$actual = apcu_fetch($prefix . $locale . '.' . $domain . '.' . $msgid);
108			$this->assertSame($expected, $actual);
109			}
110
111			public function testEnsureTranslationsLoadedSetsLoadedKey(): void
112			{
113			$expected = 1;
114			$locale = 'foo';
115			$domain = 'bar';
116
117			new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);
118
119			$actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY);
120			$this->assertSame($expected, $actual);
121			}
122
123			public function testEnsureTranslationsLoadedHonorsLock(): void
124			{
125			$locale = 'foo';
126			$domain = 'bar';
127			$msgid = 'Column';
128
129			$lock = 'mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY;
130			apcu_entry($lock, static function () {
131			sleep(1);
132
133			return 1;
134			});
135
136			new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);
137
138			$actual = apcu_fetch($lock);
139			$this->assertSame(1, $actual);
140			apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $msgid, $success);
141			$this->assertFalse($success);
142			}
143
144			public function testGetReturnsMsgstr(): void
145			{
146			$expected = 'Pole';
147			$msgid = 'Column';
148
149			$cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), 'foo', 'bar');
150
151			$actual = $cache->get($msgid);
152			$this->assertSame($expected, $actual);
153			}
154
155			public function testGetReturnsMsgidForCacheMiss(): void
156			{
157			$expected = 'Column';
158
159			$cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
160
161			$actual = $cache->get($expected);
162			$this->assertSame($expected, $actual);
163			}
164
165			public function testStoresMsgidOnCacheMiss(): void
166			{
167			$expected = 'Column';
168			$locale = 'foo';
169			$domain = 'bar';
170
171			$cache = new ApcuCache(new MoParser(null), $locale, $domain);
172			$cache->get($expected);
173
174			$actual = apcu_fetch('mo_' . $locale . '.' . $domain . '.' . $expected);
175			$this->assertSame($expected, $actual);
176			}
177
178			public function testGetReloadsOnCacheMiss(): void
179			{
180			$expected = 'Pole';
181			$locale = 'foo';
182			$domain = 'bar';
183			$msgid = 'Column';
184
185			$cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), $locale, $domain);
186
187			apcu_delete('mo_' . $locale . '.' . $domain . '.' . ApcuCache::LOADED_KEY);
188			$actual = $cache->get($msgid);
189			$this->assertSame($expected, $actual);
190			}
191
192			public function testReloadOnMissHonorsLock(): void
193			{
194			$expected = 'Pole';
195			$locale = 'foo';
196			$domain = 'bar';
197			$msgid = 'Column';
198
199			$cache = new ApcuCache(new MoParser(null), $locale, $domain);
200
201			$method = new ReflectionMethod($cache, 'reloadOnMiss');
202			$method->setAccessible(true);
203
204			$key = 'mo_' . $locale . '.' . $domain . '.' . $msgid;
205			apcu_entry($key, static function () use ($expected): string {
206			sleep(1);
207
208			return $expected;
209			});
210			$actual = $method->invoke($cache, $msgid);
211
212			$this->assertSame($expected, $actual);
213			}
214
215			public function testSetSetsMsgstr(): void
216			{
217			$expected = 'Pole';
218			$msgid = 'Column';
219
220			$cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
221			$cache->set($msgid, $expected);
222
223			$actual = $cache->get($msgid);
224			$this->assertSame($expected, $actual);
225			}
226
227			public function testHasReturnsFalse(): void
228			{
229			$cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
230			$actual = $cache->has('Column');
231			$this->assertFalse($actual);
232			}
233
234			public function testHasReturnsTrue(): void
235			{
236			$cache = new ApcuCache(new MoParser(__DIR__ . '/../data/little.mo'), 'foo', 'bar');
237			$actual = $cache->has('Column');
238			$this->assertTrue($actual);
239			}
240
241			public function testSetAllSetsTranslations(): void
242			{
243			$translations = [
244			'foo' => 'bar',
245			'and' => 'another',
246			];
247
248			$cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
249			$cache->setAll($translations);
250
251			foreach ($translations as $msgid => $expected) {
252			$actual = $cache->get($msgid);
253			$this->assertEquals($expected, $actual);
254			}
255			}
256
257			public function testCacheStoresPluralForms(): void
258			{
259			$expected = ['first', 'second'];
260			$plural = ["%d pig went to the market\n", "%d pigs went to the market\n"];
261			$msgid = implode(chr(0), $plural);
262
263			$cache = new ApcuCache(new MoParser(null), 'foo', 'bar');
264			$cache->set($msgid, implode(chr(0), $expected));
265
266			$msgstr = $cache->get($msgid);
267			$actual = explode(chr(0), $msgstr);
268			$this->assertSame($expected, $actual);
269			}
270			}
271

phpmyadmin / motranslator

Pull Request — master (#42)

ApcuCacheTest::testReloadOnMissHonorsLock() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like