ILIAS\ResourceStorage\Resource\EnsurePathInZipTest Class Reference

Regression tests for Mantis 0045580 / 0047237: entries written to a ZIP container must not start with a leading slash, otherwise some extraction tools (Windows Explorer in particular) will not list them. More...

Inheritance diagram for ILIAS\ResourceStorage\Resource\EnsurePathInZipTest:

Collaboration diagram for ILIAS\ResourceStorage\Resource\EnsurePathInZipTest:

Public Member Functions
	testFilePathHasNoLeadingSlash (string $input, string $expected)
	testDirectoryPathHasNoLeadingSlash ()
	testWritingRootFileProducesRelativeEntry ()

Static Public Member Functions
static	filePathProvider ()

Protected Member Functions
	setUp ()
	tearDown ()

Private Attributes
string	$zip_file
ZipArchive	$zip

Detailed Description

Regression tests for Mantis 0045580 / 0047237: entries written to a ZIP container must not start with a leading slash, otherwise some extraction tools (Windows Explorer in particular) will not list them.

Author

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 34 of file EnsurePathInZipTest.php.

Member Function Documentation

filePathProvider()

static ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::filePathProvider ( )

static

Definition at line 68 of file EnsurePathInZipTest.php.

                                             : \Iterator
    {
        yield 'root file, no slash' => ['index.html', 'index.html'];
        yield 'root file, leading slash' => ['/index.html', 'index.html'];
        yield 'subdir file, no slash' => ['assets/style.css', 'assets/style.css'];
        yield 'subdir file, leading slash' => ['/assets/style.css', 'assets/style.css'];
        yield 'nested file, no slash' => ['assets/css/osd.css', 'assets/css/osd.css'];
        yield 'nested file, leading slash' => ['/assets/css/osd.css', 'assets/css/osd.css'];
    }

setUp()

ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::setUp ( )

protected

Definition at line 39 of file EnsurePathInZipTest.php.

                              : void
    {
        parent::setUp();
        $this->zip_file = tempnam(sys_get_temp_dir(), 'irss_zip_test_');
        $this->zip = new ZipArchive();
        $this->zip->open($this->zip_file, ZipArchive::OVERWRITE);
    }

tearDown()

ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::tearDown ( )

protected

Definition at line 47 of file EnsurePathInZipTest.php.

                                 : void
    {
        parent::tearDown();
        if ($this->zip->filename !== '') {
            @$this->zip->close();
        }
        @unlink($this->zip_file);
    }

testDirectoryPathHasNoLeadingSlash()

ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::testDirectoryPathHasNoLeadingSlash

(

)

Definition at line 78 of file EnsurePathInZipTest.php.

                                                        : void
    {
        $method = new \ReflectionMethod(ResourceBuilder::class, 'ensurePathInZIP');
        $builder = (new \ReflectionClass(ResourceBuilder::class))->newInstanceWithoutConstructor();
 
        $result = $method->invoke($builder, $this->zip, '/dir/sub', false);
 
        $this->assertStringStartsNotWith('/', $result);
        $this->assertSame('dir/sub/', $result);
    }

testFilePathHasNoLeadingSlash()

ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::testFilePathHasNoLeadingSlash	(	string	$input,
		string	$expected
	)

Definition at line 57 of file EnsurePathInZipTest.php.

                                                                                  : void
    {
        $method = new \ReflectionMethod(ResourceBuilder::class, 'ensurePathInZIP');
        $builder = (new \ReflectionClass(ResourceBuilder::class))->newInstanceWithoutConstructor();
 
        $result = $method->invoke($builder, $this->zip, $input, true);
 
        $this->assertSame($expected, $result);
        $this->assertStringStartsNotWith('/', $result);
    }

testWritingRootFileProducesRelativeEntry()

ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::testWritingRootFileProducesRelativeEntry

(

)

Definition at line 89 of file EnsurePathInZipTest.php.

                                                              : void
    {
        $method = new \ReflectionMethod(ResourceBuilder::class, 'ensurePathInZIP');
        $builder = (new \ReflectionClass(ResourceBuilder::class))->newInstanceWithoutConstructor();
 
        $entry = $method->invoke($builder, $this->zip, '/index.html', true);
        $this->zip->addFromString($entry, '<html></html>');
        $this->zip->close();
 
        $verify = new ZipArchive();
        $verify->open($this->zip_file);
        $names = [];
        for ($i = 0; $i < $verify->numFiles; $i++) {
            $names[] = $verify->getNameIndex($i);
        }
        $verify->close();
 
        foreach ($names as $name) {
            $this->assertStringStartsNotWith('/', $name, "ZIP entry must not start with '/': {$name}");
        }
        $this->assertContains('index.html', $names);
    }

Field Documentation

$zip

ZipArchive ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::$zip

private

Definition at line 37 of file EnsurePathInZipTest.php.

$zip_file

string ILIAS\ResourceStorage\Resource\EnsurePathInZipTest::$zip_file

private

Definition at line 36 of file EnsurePathInZipTest.php.

---

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

• components/ILIAS/ResourceStorage/tests/Resource/EnsurePathInZipTest.php