File: PharExtractorTest.php

package info (click to toggle)
php-jolicode-jolinotif 3.1.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 784 kB
  • sloc: php: 1,817; makefile: 19; ansic: 11
file content (146 lines) | stat: -rw-r--r-- 5,111 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
<?php

/*
 * This file is part of the JoliNotif project.
 *
 * (c) Loïck Piera <pyrech@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Joli\JoliNotif\tests\Util;

use Joli\JoliNotif\Util\PharExtractor;
use PHPUnit\Framework\TestCase;
use Symfony\Component\Finder\Finder;

class PharExtractorTest extends TestCase
{
    public function testIsLocatedInsideAPhar()
    {
        $this->assertFalse(PharExtractor::isLocatedInsideAPhar('/var/www/my_file'));
        $this->assertFalse(PharExtractor::isLocatedInsideAPhar('http://example.com/index.php'));
        $this->assertFalse(PharExtractor::isLocatedInsideAPhar('/var/www/phar://test.phar/my_file'));
        $this->assertTrue(PharExtractor::isLocatedInsideAPhar('phar:///var/www/test.phar/my_file'));
    }

    public function testExtractFile()
    {
        $this->markTestSkipped('This test require phar.readonly="Off".');

        $key = uniqid('', true);
        $pharPath = $this->getTestDir() . '/phar-extractor-' . $key . '.phar';
        $relativeFilePath = 'path/to/file-' . $key . '.txt';
        $extractedFilePath = sys_get_temp_dir() . '/jolinotif/' . $relativeFilePath;

        $this->generatePhar($pharPath, $relativeFilePath, $key, false);
        $this->assertFileExists($pharPath);
        exec('php ' . $pharPath);
        \Phar::unlinkArchive($pharPath);

        $this->assertFileExists($extractedFilePath);
        $this->assertSame($key, file_get_contents($extractedFilePath));
        unlink($extractedFilePath);
    }

    public function testExtractFileDoesntOverwriteExistingFileIfNotSpecified()
    {
        $this->markTestSkipped('This test require phar.readonly="Off".');

        $key = uniqid('', true);
        $pharPath = $this->getTestDir() . '/phar-extractor-no-overwrite-' . $key . '.phar';
        $relativeFilePath = 'path/to/file-' . $key . '.txt';
        $extractedFilePath = sys_get_temp_dir() . '/jolinotif/' . $relativeFilePath;

        $this->generatePhar($pharPath, $relativeFilePath, $key, false);
        $this->assertFileExists($pharPath);
        exec('php ' . $pharPath);
        \Phar::unlinkArchive($pharPath);

        $this->generatePhar($pharPath, $relativeFilePath, 'new content', false);
        $this->assertFileExists($pharPath);
        exec('php ' . $pharPath);
        \Phar::unlinkArchive($pharPath);

        $this->assertFileExists($extractedFilePath);
        $this->assertSame($key, file_get_contents($extractedFilePath));
        unlink($extractedFilePath);
    }

    public function testExtractFileOverwritesExistingFileIfSpecified()
    {
        $this->markTestSkipped('This test require phar.readonly="Off".');

        $key = uniqid('', true);
        $pharPath = $this->getTestDir() . '/phar-extractor-overwrite-' . $key . '.phar';
        $relativeFilePath = 'path/to/file-' . $key . '.txt';
        $extractedFilePath = sys_get_temp_dir() . '/jolinotif/' . $relativeFilePath;

        $this->generatePhar($pharPath, $relativeFilePath, $key, false);
        $this->assertFileExists($pharPath);
        exec('php ' . $pharPath);
        \Phar::unlinkArchive($pharPath);

        $this->generatePhar($pharPath, $relativeFilePath, 'new content', true);
        $this->assertFileExists($pharPath);
        exec('php ' . $pharPath);
        \Phar::unlinkArchive($pharPath);

        $this->assertFileExists($extractedFilePath);
        $this->assertSame('new content', file_get_contents($extractedFilePath));
        unlink($extractedFilePath);
    }

    private function getTestDir(): string
    {
        $testDir = sys_get_temp_dir() . '/test-jolinotif';

        if (!is_dir($testDir)) {
            mkdir($testDir);
        }

        return $testDir;
    }

    private function generatePhar(string $pharPath, string $fileRelativePath, string $fileContent, bool $overwrite)
    {
        $rootPackage = \dirname(__DIR__, 2);
        $bootstrap = <<<'PHAR_BOOTSTRAP'
            <?php

            require __DIR__.'/vendor/autoload.php';

            $filePath = '/{{ THE_FILE }}';
            $overwrite = {{ OVERWRITE }};

            \Joli\JoliNotif\Util\PharExtractor::extractFile(__DIR__.$filePath, $overwrite);

            ?>
            PHAR_BOOTSTRAP;

        $files = (new Finder())
            ->in("{$rootPackage}/src")
            ->in("{$rootPackage}/tests/fixtures")
            ->in("{$rootPackage}/vendor")
            ->notPath('vendor/symfony/phpunit-bridge/bin/simple-phpunit')
            ->files()
        ;

        $phar = new \Phar($pharPath);
        $phar->buildFromIterator($files, $rootPackage);
        $phar->addFromString('bootstrap.php', str_replace(
            [
                '{{ THE_FILE }}',
                '{{ OVERWRITE }}',
            ],
            [
                $fileRelativePath,
                $overwrite ? 'true' : 'false',
            ],
            $bootstrap
        ));
        $phar->addFromString($fileRelativePath, $fileContent);
        $phar->setStub($phar->createDefaultStub('bootstrap.php'));
    }
}