SessionRepositoryTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Tests\Authentication\KeyValueStorage;
 
use ILIAS\Authentication\KeyValueStorage\SessionRepository;
use ILIAS\KeyValueStorage\Internal\StorageNamespace;
use PHPUnit\Framework\Attributes\BackupGlobals;
use PHPUnit\Framework\TestCase;
 
#[BackupGlobals(true)]
class SessionRepositoryTest extends TestCase
{
    private SessionRepository $repository;
 
    private StorageNamespace $namespace;
 
    protected function setUp(): void
    {
        $_SESSION = [];
        $this->repository = new SessionRepository();
        $this->namespace = new StorageNamespace(['my_component', 'view_state']);
    }
 
    public function testEachEntryIsASessionVariableOfItsOwn(): void
    {
        $this->repository->write($this->namespace, 'sort', '"title"');
 
        $this->assertSame(['kvs:my_component.view_state:sort' => '"title"'], $_SESSION);
    }
 
    public function testWhatWasWrittenCanBeReadBack(): void
    {
        $this->repository->write($this->namespace, 'sort', '"title"');
 
        $this->assertTrue($this->repository->has($this->namespace, 'sort'));
        $this->assertSame('"title"', $this->repository->read($this->namespace, 'sort'));
    }
 
    public function testAnAbsentEntryReadsAsNull(): void
    {
        $this->assertFalse($this->repository->has($this->namespace, 'sort'));
        $this->assertNull($this->repository->read($this->namespace, 'sort'));
    }
 
    public function testAForeignSessionVariableIsNotMistakenForAnEntry(): void
    {
        $_SESSION['kvs:my_component.view_state:sort'] = ['not', 'a', 'string'];
 
        $this->assertNull($this->repository->read($this->namespace, 'sort'));
    }
 
    public function testRemoveDropsOneEntry(): void
    {
        $this->repository->write($this->namespace, 'a', '1');
        $this->repository->write($this->namespace, 'b', '2');
 
        $this->repository->remove($this->namespace, 'a');
 
        $this->assertFalse($this->repository->has($this->namespace, 'a'));
        $this->assertTrue($this->repository->has($this->namespace, 'b'));
    }
 
    public function testRemoveAllLeavesOtherNamespacesAndTheRestOfTheSessionAlone(): void
    {
        $nested = new StorageNamespace(['my_component', 'view_state', 'details']);
        $sibling = new StorageNamespace(['other_component']);
        $this->repository->write($this->namespace, 'a', '1');
        $this->repository->write($nested, 'a', '2');
        $this->repository->write($sibling, 'a', '3');
        $_SESSION['AccountId'] = 6;
 
        $this->repository->removeAll($this->namespace);
 
        $this->assertFalse($this->repository->has($this->namespace, 'a'));
        $this->assertTrue($this->repository->has($nested, 'a'));
        $this->assertTrue($this->repository->has($sibling, 'a'));
        $this->assertSame(6, $_SESSION['AccountId']);
    }
 
    public function testRemoveAllOnAnEmptySessionDoesNothing(): void
    {
        $this->repository->removeAll($this->namespace);
 
        $this->assertSame([], $_SESSION);
    }
 
    public function testRemoveAllLeavesASessionThatHoldsNoEntriesUntouched(): void
    {
        $_SESSION['AccountId'] = 6;
        $_SESSION['_authsession'] = ['user' => 'root'];
 
        $this->repository->removeAll($this->namespace);
 
        $this->assertSame(['AccountId' => 6, '_authsession' => ['user' => 'root']], $_SESSION);
    }
 
    public function testANamespaceCannotReachTheEntryOfAnother(): void
    {
        $this->repository->write(new StorageNamespace(['a', 'b']), 'c', 'nested');
        $this->repository->write(new StorageNamespace(['a']), 'b.c', 'flat');
 
        $this->assertSame('nested', $this->repository->read(new StorageNamespace(['a', 'b']), 'c'));
        $this->assertSame('flat', $this->repository->read(new StorageNamespace(['a']), 'b.c'));
    }
 
    public function testReadAllReturnsEveryEntryOfTheNamespace(): void
    {
        $this->repository->write($this->namespace, 'sort', '"title"');
        $this->repository->write($this->namespace, 'limit', '10');
 
        $this->assertSame(
            ['sort' => '"title"', 'limit' => '10'],
            $this->repository->readAll($this->namespace)
        );
    }
 
    public function testReadAllDoesNotConfuseAKeyWithThePrefixOfAnother(): void
    {
        $this->repository->write($this->namespace, 'a', '1');
        $this->repository->write($this->namespace, 'ab', '2');
 
        $this->assertSame(['a' => '1', 'ab' => '2'], $this->repository->readAll($this->namespace));
    }
 
    public function testReadAllLeavesOtherNamespacesAndForeignSessionValuesAlone(): void
    {
        $nested = new StorageNamespace(['my_component', 'view_state', 'details']);
        $sibling = new StorageNamespace(['other_component']);
        $this->repository->write($this->namespace, 'a', '1');
        $this->repository->write($nested, 'a', '2');
        $this->repository->write($sibling, 'a', '3');
        $_SESSION['AccountId'] = 6;
        $_SESSION['kvs:my_component.view_state:sort'] = ['not', 'a', 'string'];
 
        $this->assertSame(['a' => '1'], $this->repository->readAll($this->namespace));
        $this->assertSame(6, $_SESSION['AccountId']);
    }
 
    public function testReadAllOnAnEmptySessionIsEmpty(): void
    {
        $this->assertSame([], $this->repository->readAll($this->namespace));
    }
}