GetFileInfoResponseTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\WOPI\Handler;
 
use PHPUnit\Framework\TestCase;
use ILIAS\ResourceStorage\Revision\Revision;
use ILIAS\ResourceStorage\Information\Information;
 
final class GetFileInfoResponseTest extends TestCase
{
    protected function setUp(): void
    {
        if (!defined('ILIAS_HTTP_PATH')) {
            define('ILIAS_HTTP_PATH', 'https://ilias.example.org');
        }
 
        $GLOBALS['DIC'] ??= new \ILIAS\DI\Container();
        if (!isset($GLOBALS['DIC']['ilDB'])) {
            $db = $this->createStub(\ilDBInterface::class);
            $db->method('queryF')->willReturn($this->createStub(\ilDBStatement::class));
            $db->method('fetchAssoc')->willReturn(
                ['firstname' => 'Ada', 'lastname' => 'Lovelace', 'title' => '', 'login' => 'ada']
            );
            $GLOBALS['DIC']['ilDB'] = static fn(): \ilDBInterface => $db;
        }
    }
 
    private function responseFor(bool $editable, ?bool $user_can_write = null): array
    {
        $information = $this->createStub(Information::class);
        $information->method('getSuffix')->willReturn('odt');
        $information->method('getSize')->willReturn(1234);
        $information->method('getCreationDate')->willReturn(new \DateTimeImmutable('2026-01-01 12:00:00'));
 
        $revision = $this->createStub(Revision::class);
        $revision->method('getTitle')->willReturn('minutes.odt');
        $revision->method('getVersionNumber')->willReturn(3);
        $revision->method('getOwnerId')->willReturn(6);
        $revision->method('getInformation')->willReturn($information);
 
        return (new GetFileInfoResponse($revision, 6, $editable, $user_can_write))->jsonSerialize();
    }
 
    public function testViewSessionDoesNotClaimRestrictionsItDoesNotMean(): void
    {
        $response = $this->responseFor(false);
 
        $this->assertArrayNotHasKey('RestrictedWebViewOnly', $response);
        $this->assertArrayNotHasKey('UserCanAttend', $response);
    }
 
    public function testEditSessionDoesNotClaimRestrictionsItDoesNotMean(): void
    {
        $response = $this->responseFor(true);
 
        $this->assertArrayNotHasKey('RestrictedWebViewOnly', $response);
        $this->assertArrayNotHasKey('UserCanAttend', $response);
    }
 
    public function testViewSessionStaysReadOnly(): void
    {
        $response = $this->responseFor(false);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['UserCanWrite']);
        $this->assertFalse($response['SupportsUpdate']);
    }
 
    public function testEditSessionMayWrite(): void
    {
        $response = $this->responseFor(true);
 
        $this->assertFalse($response['ReadOnly']);
        $this->assertTrue($response['UserCanWrite']);
        $this->assertTrue($response['SupportsUpdate']);
    }
 
    public function testViewSessionOfAUserWhoMayWriteStaysReadOnlyButDoesNotBlameTheirRights(): void
    {
        $response = $this->responseFor(false, true);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['SupportsUpdate']);
        $this->assertTrue($response['UserCanWrite']);
    }
 
    public function testViewSessionOfAUserWhoMayNotWrite(): void
    {
        $response = $this->responseFor(false, false);
 
        $this->assertTrue($response['ReadOnly']);
        $this->assertFalse($response['SupportsUpdate']);
        $this->assertFalse($response['UserCanWrite']);
    }
 
    public function testTheHostDoesNotOfferAWayIntoEditMode(): void
    {
        $this->assertFalse($this->responseFor(false, true)['EditModePostMessage']);
        $this->assertFalse($this->responseFor(true)['EditModePostMessage']);
    }
 
    public function testNoCloseButtonOfTheClientIsAnnounced(): void
    {
        foreach ([false, true] as $editable) {
            $response = $this->responseFor($editable);
 
            $this->assertArrayNotHasKey('CloseUrl', $response);
            $this->assertFalse($response['ClosePostMessage']);
        }
    }
 
    public function testIdsAndVersionAreStrings(): void
    {
        $response = $this->responseFor(true);
 
        $this->assertSame('6', $response['OwnerId']);
        $this->assertSame('6', $response['UserId']);
        $this->assertIsString($response['Version']);
    }
}