CustomIconTempUploadPathTest Class Reference

Inheritance diagram for CustomIconTempUploadPathTest:

Collaboration diagram for CustomIconTempUploadPathTest:

Public Member Functions
	testTrustedTempUploadFileIsResolved ()
	testParentDirectorySegmentsInUserInputAreRejected ()
	testAbsentTempUploadFileIsRejected ()
	testInvalidTemporaryFileNameIsRejected (string $malicious_input)

Static Public Member Functions
static	invalidTemporaryFileNameProvider ()

Private Member Functions
	vfsStreamIsAvailable ()
	skipIfVfsStreamNotAvailable ()
	buildTestingObject (string $temp_file_name, string $ilias_data_dir)

Detailed Description

Definition at line 26 of file CustomIconTempUploadPathTest.php.

Member Function Documentation

buildTestingObject()

CustomIconTempUploadPathTest::buildTestingObject ( string  $temp_file_name, string  $ilias_data_dir  )

private

Definition at line 42 of file CustomIconTempUploadPathTest.php.

     : CustomIconTempUploadPath {
        return new class (
            $temp_file_name,
            $ilias_data_dir
        ) extends CustomIconTempUploadPath {
            #[\Override]
            protected function getRealPath(
                string $path
            ): string|false {
                $normalized = str_replace('\\', '/', $path);
                if (is_dir($path)) {
                    return rtrim($normalized, '/');
                }
 
                if (is_file($path)) {
                    return $normalized;
                }
 
                return false;
            }
        };
    }

invalidTemporaryFileNameProvider()

static CustomIconTempUploadPathTest::invalidTemporaryFileNameProvider ( )

static

Returns

Generator<string, array{0: string}>

Definition at line 153 of file CustomIconTempUploadPathTest.php.

                                                             : Generator
    {
        yield 'parent directory segment' => ['..'];
        yield 'current directory segment' => ['.'];
    }

skipIfVfsStreamNotAvailable()

CustomIconTempUploadPathTest::skipIfVfsStreamNotAvailable ( )

private

Definition at line 33 of file CustomIconTempUploadPathTest.php.

                                                  : void
    {
        if (!$this->vfsStreamIsAvailable()) {
            $this->markTestSkipped(
                'vfsStream (https://github.com/bovigo/vfsStream) is required for virtual filesystem tests.'
            );
        }
    }

References vfsStreamIsAvailable().

Here is the call graph for this function:

testAbsentTempUploadFileIsRejected()

CustomIconTempUploadPathTest::testAbsentTempUploadFileIsRejected

(

)

Definition at line 115 of file CustomIconTempUploadPathTest.php.

                                                        : void
    {
        $this->skipIfVfsStreamNotAvailable();
 
        vfs\vfsStream::setup();
        vfs\vfsStream::create([
            'data' => [
                'temp' => [],
            ],
        ]);
 
        $data_dir = vfs\vfsStream::url('root/data');
 
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Temporary upload file not found.');
 
        $this->buildTestingObject(
            'missing.svg',
            $data_dir
        );
    }

References $data_dir.

testInvalidTemporaryFileNameIsRejected()

CustomIconTempUploadPathTest::testInvalidTemporaryFileNameIsRejected

(

string

$malicious_input

)

Definition at line 138 of file CustomIconTempUploadPathTest.php.

     : void {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Invalid temporary upload file name.');
 
        $this->buildTestingObject(
            $malicious_input,
            '/does/not/matter'
        );
    }

testParentDirectorySegmentsInUserInputAreRejected()

CustomIconTempUploadPathTest::testParentDirectorySegmentsInUserInputAreRejected

(

)

Definition at line 92 of file CustomIconTempUploadPathTest.php.

                                                                       : void
    {
        $this->skipIfVfsStreamNotAvailable();
 
        vfs\vfsStream::setup();
        vfs\vfsStream::create([
            'data' => [
                'secret.txt' => 'sensitive',
                'temp' => [],
            ],
        ]);
 
        $data_dir = vfs\vfsStream::url('root/data');
 
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionMessage('Temporary upload file not found.');
 
        $this->buildTestingObject(
            '../secret.txt',
            $data_dir
        );
    }

References $data_dir.

testTrustedTempUploadFileIsResolved()

CustomIconTempUploadPathTest::testTrustedTempUploadFileIsResolved

(

)

Definition at line 68 of file CustomIconTempUploadPathTest.php.

                                                         : void
    {
        $this->skipIfVfsStreamNotAvailable();
 
        vfs\vfsStream::setup();
        vfs\vfsStream::create([
            'data' => [
                'temp' => [
                    'icon_upload.svg' => '<svg xmlns="http://www.w3.org/2000/svg"/>',
                ],
            ],
        ]);
 
        $data_dir = vfs\vfsStream::url('root/data');
        $expected_file = vfs\vfsStream::url('root/data/temp/icon_upload.svg');
 
        $path = $this->buildTestingObject(
            'icon_upload.svg',
            $data_dir
        );
 
        self::assertSame($expected_file, $path->getAbsolutePath());
    }

References $data_dir, and $path.

vfsStreamIsAvailable()

CustomIconTempUploadPathTest::vfsStreamIsAvailable ( )

private

Definition at line 28 of file CustomIconTempUploadPathTest.php.

                                           : bool
    {
        return class_exists(vfs\vfsStreamWrapper::class);
    }

Referenced by skipIfVfsStreamNotAvailable().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/ILIASObject/tests/CustomIconTempUploadPathTest.php