123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217 |
- <?php
- declare(strict_types=1);
- /*
- * This file is part of PHP CS Fixer.
- *
- * (c) Fabien Potencier <fabien@symfony.com>
- * Dariusz Rumiński <dariusz.ruminski@gmail.com>
- *
- * This source file is subject to the MIT license that is bundled
- * with this source code in the file LICENSE.
- */
- namespace PhpCsFixer\Tests\Cache;
- use PhpCsFixer\Cache\Cache;
- use PhpCsFixer\Cache\CacheInterface;
- use PhpCsFixer\Cache\FileHandler;
- use PhpCsFixer\Cache\Signature;
- use PhpCsFixer\Cache\SignatureInterface;
- use PhpCsFixer\Tests\TestCase;
- use Symfony\Component\Filesystem\Exception\IOException;
- /**
- * @author Andreas Möller <am@localheinz.com>
- *
- * @internal
- *
- * @covers \PhpCsFixer\Cache\FileHandler
- */
- final class FileHandlerTest extends TestCase
- {
- protected function tearDown(): void
- {
- parent::tearDown();
- $file = $this->getFile();
- if (file_exists($file)) {
- unlink($file);
- }
- }
- public function testConstructorSetsFile(): void
- {
- $file = $this->getFile();
- $handler = new FileHandler($file);
- self::assertSame($file, $handler->getFile());
- }
- public function testReadReturnsNullIfFileDoesNotExist(): void
- {
- $file = $this->getFile();
- $handler = new FileHandler($file);
- self::assertNull($handler->read());
- }
- public function testReadReturnsNullIfContentCanNotBeDeserialized(): void
- {
- $file = $this->getFile();
- file_put_contents($file, 'hello');
- $handler = new FileHandler($file);
- self::assertNull($handler->read());
- }
- public function testReadReturnsCache(): void
- {
- $file = $this->getFile();
- $signature = $this->createSignature();
- $cache = new Cache($signature);
- file_put_contents($file, $cache->toJson());
- $handler = new FileHandler($file);
- $cached = $handler->read();
- self::assertInstanceOf(CacheInterface::class, $cached);
- self::assertTrue($cached->getSignature()->equals($signature));
- }
- public function testWriteThrowsIOExceptionIfFileCanNotBeWritten(): void
- {
- $file = '/../"/out/of/range/cache.json'; // impossible path
- $this->expectException(IOException::class);
- $this->expectExceptionMessageMatches(\sprintf(
- '#^Directory of cache file "%s" does not exists and couldn\'t be created\.#',
- preg_quote($file, '#')
- ));
- $cache = new Cache($this->createSignature());
- $handler = new FileHandler($file);
- $handler->write($cache);
- }
- public function testWriteWritesCache(): void
- {
- $file = $this->getFile();
- $cache = new Cache($this->createSignature());
- $handler = new FileHandler($file);
- $handler->write($cache);
- self::assertFileExists($file);
- $actualCacheJson = file_get_contents($file);
- self::assertSame($cache->toJson(), $actualCacheJson);
- }
- public function testWriteCacheToDirectory(): void
- {
- $dir = __DIR__.'/../Fixtures/cache-file-handler';
- $handler = new FileHandler($dir);
- $this->expectException(IOException::class);
- $this->expectExceptionMessageMatches(\sprintf(
- '#^%s$#',
- preg_quote('Cannot write cache file "'.realpath($dir).'" as the location exists as directory.', '#')
- ));
- $handler->write(new Cache($this->createSignature()));
- }
- public function testWriteCacheToNonWriteableFile(): void
- {
- $file = __DIR__.'/../Fixtures/cache-file-handler/cache-file';
- if (is_writable($file)) {
- self::markTestSkipped(\sprintf('File "%s" must be not writeable for this tests.', realpath($file)));
- }
- $handler = new FileHandler($file);
- $this->expectException(IOException::class);
- $this->expectExceptionMessageMatches(\sprintf(
- '#^%s$#',
- preg_quote('Cannot write to file "'.realpath($file).'" as it is not writable.', '#')
- ));
- $handler->write(new Cache($this->createSignature()));
- }
- public function testWriteCacheFilePermissions(): void
- {
- $file = __DIR__.'/../Fixtures/cache-file-handler/rw_cache.test';
- @unlink($file);
- self::assertFileDoesNotExist($file);
- $handler = new FileHandler($file);
- $handler->write(new Cache($this->createSignature()));
- self::assertFileExists($file);
- self::assertTrue(@is_file($file), \sprintf('Failed cache "%s" `is_file`.', $file));
- self::assertTrue(@is_writable($file), \sprintf('Failed cache "%s" `is_writable`.', $file));
- self::assertTrue(@is_readable($file), \sprintf('Failed cache "%s" `is_readable`.', $file));
- @unlink($file);
- }
- public function testCachePathIsCreated(): void
- {
- $dir = __DIR__.'/../Fixtures/cache-file-handler/one/two/three';
- $file = $dir.'/cache.json';
- $cleanPath = static function () use ($dir, $file): void {
- @unlink($file);
- for ($i = 0; $i <= 2; ++$i) {
- @rmdir(0 === $i ? $dir : \dirname($dir, $i));
- }
- };
- $cleanPath();
- self::assertDirectoryDoesNotExist($dir);
- self::assertFileDoesNotExist($file);
- $handler = new FileHandler($file);
- $handler->write(new Cache($this->createSignature()));
- self::assertDirectoryExists($dir);
- self::assertFileExists($file);
- $cleanPath();
- }
- private function getFile(): string
- {
- return __DIR__.'/.php-cs-fixer.cache';
- }
- private function createSignature(): SignatureInterface
- {
- return new Signature(
- PHP_VERSION,
- '2.0',
- ' ',
- PHP_EOL,
- ['foo' => true, 'bar' => false],
- );
- }
- }
|