ApcuHandlerTest.php

<?php

declare(strict_types=1);

/**
 * This file is part of CodeIgniter 4 framework.
 *
 * (c) CodeIgniter Foundation <admin@codeigniter.com>
 *
 * For the full copyright and license information, please view
 * the LICENSE file that was distributed with this source code.
 */

namespace CodeIgniter\Cache\Handlers;

use CodeIgniter\Cache\CacheFactory;
use CodeIgniter\CLI\CLI;
use CodeIgniter\I18n\Time;
use Config\Cache;
use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RequiresPhpExtension;

/**
 * @internal
 */
#[Group('CacheLive')]
#[RequiresPhpExtension('apcu')]
final class ApcuHandlerTest extends AbstractHandlerTestCase
{
    /**
     * @return list<string>
     */
    private static function getKeyArray(): array
    {
        return [
            self::$key1,
            self::$key2,
            self::$key3,
        ];
    }

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

        $this->handler = CacheFactory::getHandler(new Cache(), 'apcu');
    }

    protected function tearDown(): void
    {
        foreach (self::getKeyArray() as $key) {
            $this->handler->delete($key);
        }
    }

    public function testNew(): void
    {
        $this->assertInstanceOf(ApcuHandler::class, $this->handler);
    }

    /**
     * This test waits for 3 seconds before last assertion so this
     * is naturally a "slow" test on the perspective of the default limit.
     *
     * @timeLimit 3.5
     */
    public function testGet(): void
    {
        $this->handler->save(self::$key1, 'value', 2);

        $this->assertSame('value', $this->handler->get(self::$key1));
        $this->assertNull($this->handler->get(self::$dummy));

        CLI::wait(3);
        $this->assertNull($this->handler->get(self::$key1));
    }

    /**
     * This test waits for 3 seconds before last assertion so this
     * is naturally a "slow" test on the perspective of the default limit.
     *
     * @timeLimit 3.5
     */
    public function testRemember(): void
    {
        $this->handler->remember(self::$key1, 2, static fn (): string => 'value');

        $this->assertSame('value', $this->handler->get(self::$key1));
        $this->assertNull($this->handler->get(self::$dummy));

        CLI::wait(3);
        $this->assertNull($this->handler->get(self::$key1));
    }

    public function testSave(): void
    {
        $this->assertTrue($this->handler->save(self::$key1, 'value'));
    }

    public function testSavePermanent(): void
    {
        $this->assertTrue($this->handler->save(self::$key1, 'value', 0));
        $metaData = $this->handler->getMetaData(self::$key1);

        $this->assertNull($metaData['expire']);
        $this->assertLessThanOrEqual(1, $metaData['mtime'] - Time::now()->getTimestamp());
        $this->assertSame('value', $metaData['data']);

        $this->assertTrue($this->handler->delete(self::$key1));
    }

    public function testDelete(): void
    {
        $this->handler->save(self::$key1, 'value');

        $this->assertTrue($this->handler->delete(self::$key1));
        $this->assertFalse($this->handler->delete(self::$dummy));
    }

    public function testDeleteMatching(): void
    {
        // Save items to match on
        for ($i = 1; $i <= 50; $i++) {
            $this->handler->save('key_' . $i, 'value' . $i);
        }

        // Checking that with pattern 'key_1*' only 11 entries deleted:
        // key_1, key_10, key_11, key_12, key_13, key_14, key_15, key_16, key_17, key_18, key_19
        $this->assertSame(11, $this->handler->deleteMatching('key_1*'));

        // Checking that with pattern '*1', only 3 entries deleted:
        // key_21, key_31, key_41
        $this->assertSame(3, $this->handler->deleteMatching('key_*1'));

        // Checking that with pattern '*5*' only 5 entries deleted:
        // key_5, key_25, key_35, key_45, key_50
        $this->assertSame(5, $this->handler->deleteMatching('*5*'));

        // Check final number of cache entries
        $this->assertSame(31, $this->handler->getCacheInfo()['num_entries']);
    }

    public function testIncrementAndDecrement(): void
    {
        $this->handler->save('counter', 100);

        foreach (range(1, 10) as $step) {
            $this->handler->increment('counter', $step);
        }

        $this->assertSame(155, $this->handler->get('counter'));

        $this->handler->decrement('counter', 20);
        $this->assertSame(135, $this->handler->get('counter'));

        $this->handler->increment('counter', 5);
        $this->assertSame(140, $this->handler->get('counter'));
    }

    public function testClean(): void
    {
        $this->handler->save(self::$key1, 1);

        $this->assertTrue($this->handler->clean());
    }

    public function testGetCacheInfo(): void
    {
        $this->handler->save(self::$key1, 'value');

        $this->assertIsArray($this->handler->getCacheInfo());
    }

    public function testIsSupported(): void
    {
        $this->assertTrue($this->handler->isSupported());
    }
}