class FileSystemTest in Drupal 10

@coversDefaultClass \Drupal\Core\File\FileSystem

@group File

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\File\FileSystemTest

File

core/tests/Drupal/Tests/Core/File/FileSystemTest.php, line 17

Namespace

Drupal\Tests\Core\File

class FileSystemTest extends UnitTestCase {

  /**
   * @var \Drupal\Core\File\FileSystemInterface
   */
  protected $fileSystem;

  /**
   * The file logger channel.
   *
   * @var \Psr\Log\LoggerInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $logger;

  /**
   * The stream wrapper manager.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperInterface|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $streamWrapperManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $settings = new Settings([]);
    $this->streamWrapperManager = $this
      ->createMock(StreamWrapperManagerInterface::class);
    $this->logger = $this
      ->createMock('Psr\\Log\\LoggerInterface');
    $this->fileSystem = new FileSystem($this->streamWrapperManager, $settings, $this->logger);
  }

  /**
   * @covers ::chmod
   */
  public function testChmodFile() {
    vfsStream::setup('dir');
    vfsStream::create([
      'test.txt' => 'asdf',
    ]);
    $uri = 'vfs://dir/test.txt';
    $this
      ->assertTrue($this->fileSystem
      ->chmod($uri));
    $this
      ->assertFilePermissions(FileSystem::CHMOD_FILE, $uri);
    $this
      ->assertTrue($this->fileSystem
      ->chmod($uri, 0444));
    $this
      ->assertFilePermissions(0444, $uri);
  }

  /**
   * @covers ::chmod
   */
  public function testChmodDir() {
    vfsStream::setup('dir');
    vfsStream::create([
      'nested_dir' => [],
    ]);
    $uri = 'vfs://dir/nested_dir';
    $this
      ->assertTrue($this->fileSystem
      ->chmod($uri));
    $this
      ->assertFilePermissions(FileSystem::CHMOD_DIRECTORY, $uri);
    $this
      ->assertTrue($this->fileSystem
      ->chmod($uri, 0444));
    $this
      ->assertFilePermissions(0444, $uri);
  }

  /**
   * @covers ::chmod
   */
  public function testChmodUnsuccessful() {
    vfsStream::setup('dir');
    $this->logger
      ->expects($this
      ->once())
      ->method('error');
    $this
      ->assertFalse($this->fileSystem
      ->chmod('vfs://dir/test.txt'));
  }

  /**
   * @covers ::unlink
   */
  public function testUnlink() {
    vfsStream::setup('dir');
    vfsStream::create([
      'test.txt' => 'asdf',
    ]);
    $uri = 'vfs://dir/test.txt';
    $this->streamWrapperManager
      ->expects($this
      ->once())
      ->method('isValidUri')
      ->willReturn(TRUE);
    $this
      ->assertFileExists($uri);
    $this->fileSystem
      ->unlink($uri);
    $this
      ->assertFileDoesNotExist($uri);
  }

  /**
   * @covers ::basename
   *
   * @dataProvider providerTestBasename
   */
  public function testBasename($uri, $expected, $suffix = NULL) {
    $this
      ->assertSame($expected, $this->fileSystem
      ->basename($uri, $suffix));
  }
  public function providerTestBasename() {
    $data = [];
    $data[] = [
      'public://nested/dir',
      'dir',
    ];
    $data[] = [
      'public://dir/test.txt',
      'test.txt',
    ];
    $data[] = [
      'public://dir/test.txt',
      'test',
      '.txt',
    ];
    return $data;
  }

  /**
   * Asserts that the file permissions of a given URI matches.
   *
   * @param int $expected_mode
   *   The expected file mode.
   * @param string $uri
   *   The URI to test.
   * @param string $message
   *   An optional error message.
   *
   * @internal
   */
  protected function assertFilePermissions(int $expected_mode, string $uri, string $message = '') : void {

    // Mask out all but the last three octets.
    $actual_mode = fileperms($uri) & 0777;

    // PHP on Windows has limited support for file permissions. Usually each of
    // "user", "group" and "other" use one octal digit (3 bits) to represent the
    // read/write/execute bits. On Windows, chmod() ignores the "group" and
    // "other" bits, and fileperms() returns the "user" bits in all three
    // positions. $expected_mode is updated to reflect this.
    if (substr(PHP_OS, 0, 3) == 'WIN') {

      // Reset the "group" and "other" bits.
      $expected_mode = $expected_mode & 0700;

      // Shift the "user" bits to the "group" and "other" positions also.
      $expected_mode = $expected_mode | $expected_mode >> 3 | $expected_mode >> 6;
    }
    $this
      ->assertSame($expected_mode, $actual_mode, $message);
  }

  /**
   * Tests that invalid UTF-8 results in an exception.
   *
   * @covers ::createFilename
   */
  public function testInvalidUTF8() {
    vfsStream::setup('dir');
    $filename = "" . '.txt';
    $this
      ->expectException(FileException::class);
    $this
      ->expectExceptionMessage("Invalid filename '{$filename}'");
    $this->fileSystem
      ->createFilename($filename, 'vfs://dir');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileSystemTest::$fileSystem	protected	property
FileSystemTest::$logger	protected	property	The file logger channel.
FileSystemTest::$streamWrapperManager	protected	property	The stream wrapper manager.
FileSystemTest::assertFilePermissions	protected	function	Asserts that the file permissions of a given URI matches.
FileSystemTest::providerTestBasename	public	function
FileSystemTest::setUp	protected	function	Overrides UnitTestCase::setUp
FileSystemTest::testBasename	public	function	@covers ::basename
FileSystemTest::testChmodDir	public	function	@covers ::chmod
FileSystemTest::testChmodFile	public	function	@covers ::chmod
FileSystemTest::testChmodUnsuccessful	public	function	@covers ::chmod
FileSystemTest::testInvalidUTF8	public	function	Tests that invalid UTF-8 results in an exception.
FileSystemTest::testUnlink	public	function	@covers ::unlink
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUpBeforeClass	public static	function