ilModulesFileTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\MockObject\MockObject;
use ILIAS\Refinery\Factory;
use PHPUnit\Framework\Attributes\PreserveGlobalState;
use PHPUnit\Framework\Attributes\RunInSeparateProcess;
use PHPUnit\Framework\TestCase;
use ILIAS\Filesystem\Stream\Streams;
use ILIAS\DI\Container;
use ILIAS\ResourceStorage\Services;
use ILIAS\FileUpload\FileUpload;
use ILIAS\ResourceStorage\Manager\Manager;
use ILIAS\ResourceStorage\Identification\ResourceIdentification;
use ILIAS\ResourceStorage\Revision\FileRevision;
use ILIAS\ResourceStorage\Resource\StorableFileResource;
use ILIAS\ILIASObject\Properties\AdditionalProperties\Icon\Factory as IconFactory;

class ilModulesFileTest extends TestCase
{
    private ?Container $dic_backup = null;
    protected ?MockObject $storage_mock = null;
    protected ?MockObject $db_mock = null;
    protected MockObject $manager_mock;

    protected function setUp(): void
    {
        global $DIC;
        $this->dic_backup = is_object($DIC) ? clone $DIC : null;

        $DIC = new Container();
        $DIC['resource_storage'] = $this->storage_mock = $this->createMock(Services::class);
        $this->manager_mock = $this->createMock(Manager::class);
        $DIC['ilUser'] = $this->createMock(ilObjUser::class);
        $DIC['ilUser']->expects($this->any())->method('getPref')->willReturn('en');
        $DIC['ilDB'] = $this->db_mock = $this->createMock(ilDBInterface::class);
        $DIC['upload'] = $this->createMock(FileUpload::class);
        $DIC['ilias'] = $this->createMock(ILIAS::class);
        $DIC['objDefinition'] = $this->createMock(ilObjectDefinition::class);
        $DIC['ilLog'] = $this->createMock(ilLogger::class);
        $DIC['ilErr'] = $this->createMock(ilErrorHandling::class);
        $DIC['tree'] = $this->createMock(ilTree::class);
        $DIC['tpl'] = $this->createMock(ilGlobalTemplateInterface::class);
        $DIC['ilClientIniFile'] = $this->createMock(ilIniFile::class);
        $DIC['ilAccess'] = $this->createMock(ilAccess::class);
        $DIC['ilObjDataCache'] = $this->createMock(ilObjectDataCache::class);
        $DIC['ilAppEventHandler'] = $this->createMock(ilAppEventHandler::class);
        $DIC['lng'] = $this->createMock(ilLanguage::class);
        $DIC['ilCtrl'] = $this->createMock(ilCtrlInterface::class);
        $DIC['refinery'] = $this->createMock(Factory::class);
        $DIC['http'] = $this->createMock(\ILIAS\HTTP\Services::class);
        $DIC['object.customicons.factory'] = $this->createMock(IconFactory::class);
        /*  $DIC['ilCtrl'] = $this->getMockBuilder(ilCtrl::class)
                                ->disableOriginalConstructor()
                                ->disableArgumentCloning()
                                ->getMock();*/

        if (!defined('ILIAS_LOG_ENABLED')) {
            define('ILIAS_LOG_ENABLED', false);
        }
    }

    protected function tearDown(): void
    {
        global $DIC;
        $DIC = $this->dic_backup;
    }

    #[PreserveGlobalState(false)]
    #[RunInSeparateProcess]
    public function testAppendStream(): void
    {
        $this->markTestSkipped('Failed for some unknown reason.');

        // DB mock
        $title = 'Revision One';
        $file_stream = Streams::ofString('Test Content');

        $this->storage_mock->expects($this->any())
                           ->method('manage')
                           ->willReturn($this->manager_mock);

        $this->db_mock->expects($this->any())
                      ->method('query')
                      ->willReturnCallback(function ($query): MockObject {
                          $mock_object = $this->createMock(ilDBStatement::class);
                          $mock_object->expects($this->any())->method('fetchAssoc')->willReturn([$query]);

                          return $mock_object;
                      });

        $this->db_mock->expects($this->any())
                      ->method('fetchAssoc')
                      ->willReturnCallback(function (ilDBStatement $statement): ?array {
                          $row = $statement->fetchAssoc();
                          $query = '';
                          if ($row !== null) {
                              $query = end($row);
                          }
                          if (str_contains($query, 'last_update')) {
                              return [
                                  'last_update' => '',
                                  'create_date' => ''
                              ];
                          }

                          return null;
                      });

        // Create File Object with disabled news notification
        $file = $this->getMockBuilder(ilObjFile::class)
            ->onlyMethods(['update'])
            ->getMock();
        $file->method('update');

        $r = new ReflectionClass(ilObjFile::class);
        $property = $r->getProperty('just_notified');
        $property->setAccessible(true);
        $property->setValue($file, true);
        $file->setMode(ilObjFile::MODE_FILELIST);
        $this->db_mock->expects($this->any())
                      ->method('fetchAssoc')
                      ->willReturn(
                          [
                              'last_update' => '',
                              'create_date' => ''
                          ]
                      );
        $file->create();

        // identification
        $rid = new ResourceIdentification('the_identification');

        $consecutive = [
            ['-', null],
            ['the_identification', $rid],
            ['the_identification', $rid],
        ];
        $this->manager_mock
            ->expects($this->any())
            ->method('find')
            ->willReturnCallback(
                function (string $id) use (&$consecutive): ?ResourceIdentification {
                    $expected = array_shift($consecutive);
                    [$eid, $ret] = $consecutive;
                    $this->assertEquals($eid, $id);
                    return $ret;
                }
            );

        $this->manager_mock->expects($this->once())
                           ->method('stream')
                           ->with($file_stream, new ilObjFileStakeholder(0), $title)
                           ->willReturn($rid);

        $revision = new FileRevision($rid);
        $revision->setVersionNumber(1);
        $revision->setTitle($title);
        $resource = new StorableFileResource($rid);
        $resource->addRevision($revision);

        $this->manager_mock->expects($this->once())
                           ->method('getCurrentRevision')
                           ->with($rid)
                           ->willReturn($revision);

        $this->manager_mock->expects($this->any())
                           ->method('getResource')
                           ->with($rid)
                           ->willReturn($resource);

        $revision_number = $file->appendStream($file_stream, $title);
        $this->assertEquals(1, $revision_number);
        $this->assertEquals(1, $file->getVersion());
        $this->assertEquals($title, $file->getTitle());
    }
}