ReadOnlyStreamWrapperTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\File;

use Drupal\Core\StreamWrapper\StreamWrapperInterface;
use Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper;

/**
 * Tests the read-only stream wrapper write functions.
 *
 * @group File
 */
class ReadOnlyStreamWrapperTest extends FileTestBase {
    
    /**
     * A stream wrapper scheme to register for the test.
     *
     * @var string
     */
    protected $scheme = 'dummy-readonly';
    
    /**
     * A fully-qualified stream wrapper class name to register for the test.
     *
     * @var string
     */
    protected $classname = 'Drupal\\file_test\\StreamWrapper\\DummyReadOnlyStreamWrapper';
    
    /**
     * Tests read-only specific behavior.
     */
    public function testReadOnlyBehavior() : void {
        $type = DummyReadOnlyStreamWrapper::getType();
        // Checks that the stream wrapper type is not declared as writable.
        $this->assertSame(0, $type & StreamWrapperInterface::WRITE);
        // Checks that the stream wrapper type is declared as local.
        $this->assertSame(1, $type & StreamWrapperInterface::LOCAL);
        // Generate a test file
        $filename = $this->randomMachineName();
        $site_path = $this->container
            ->getParameter('site.path');
        $filepath = $site_path . '/files/' . $filename;
        file_put_contents($filepath, $filename);
        // Generate a read-only stream wrapper instance
        $uri = $this->scheme . '://' . $filename;
        \Drupal::service('stream_wrapper_manager')->getViaScheme($this->scheme);
        $file_system = \Drupal::service('file_system');
        // Attempt to open a file in read/write mode
        $handle = @fopen($uri, 'r+');
        $this->assertFalse($handle, 'Unable to open a file for reading and writing with the read-only stream wrapper.');
        // Attempt to open a file in binary read mode
        $handle = fopen($uri, 'rb');
        $this->assertNotFalse($handle, 'Able to open a file for reading in binary mode with the read-only stream wrapper.');
        $this->assertTrue(fclose($handle), 'Able to close file opened in binary mode using the read_only stream wrapper.');
        // Attempt to open a file in text read mode
        $handle = fopen($uri, 'rt');
        $this->assertNotFalse($handle, 'Able to open a file for reading in text mode with the read-only stream wrapper.');
        $this->assertTrue(fclose($handle), 'Able to close file opened in text mode using the read_only stream wrapper.');
        // Attempt to open a file in read mode
        $handle = fopen($uri, 'r');
        $this->assertNotFalse($handle, 'Able to open a file for reading with the read-only stream wrapper.');
        // Attempt to change file permissions
        $this->assertFalse(@chmod($uri, 0777), 'Unable to change file permissions when using read-only stream wrapper.');
        // Attempt to acquire an exclusive lock for writing
        $this->assertFalse(@flock($handle, LOCK_EX | LOCK_NB), 'Unable to acquire an exclusive lock using the read-only stream wrapper.');
        // Attempt to obtain a shared lock
        $this->assertTrue(flock($handle, LOCK_SH | LOCK_NB), 'Able to acquire a shared lock using the read-only stream wrapper.');
        // Attempt to release a shared lock
        $this->assertTrue(flock($handle, LOCK_UN | LOCK_NB), 'Able to release a shared lock using the read-only stream wrapper.');
        // Attempt to truncate the file
        $this->assertFalse(@ftruncate($handle, 0), 'Unable to truncate using the read-only stream wrapper.');
        // Attempt to write to the file
        $this->assertEquals(0, @fwrite($handle, $this->randomMachineName()), 'Unable to write to file using the read-only stream wrapper.');
        // Attempt to flush output to the file
        $this->assertFalse(@fflush($handle), 'Unable to flush output to file using the read-only stream wrapper.');
        // Attempt to close the stream.  (Suppress errors, as fclose triggers fflush.)
        $this->assertTrue(fclose($handle), 'Able to close file using the read_only stream wrapper.');
        // Test the rename() function
        $this->assertFalse(@rename($uri, $this->scheme . '://new_name.txt'), 'Unable to rename files using the read-only stream wrapper.');
        // Test the unlink() function
        $this->assertTrue(@$file_system->unlink($uri), 'Able to unlink file using read-only stream wrapper.');
        $this->assertFileExists($filepath);
        // Test the mkdir() function by attempting to create a directory.
        $dirname = $this->randomMachineName();
        $dir = $site_path . '/files/' . $dirname;
        $read_only_dir = $this->scheme . '://' . $dirname;
        
        /** @var \Drupal\Core\File\FileSystemInterface $file_system */
        $file_system = \Drupal::service('file_system');
        $this->assertFalse(@$file_system->mkdir($read_only_dir, 0775, 0), 'Unable to create directory with read-only stream wrapper.');
        // Create a temporary directory for testing purposes
        $this->assertTrue($file_system->mkdir($dir), 'Test directory created.');
        // Test the rmdir() function by attempting to remove the directory.
        $this->assertFalse(@$file_system->rmdir($read_only_dir), 'Unable to delete directory with read-only stream wrapper.');
        // Remove the temporary directory.
        $file_system->rmdir($dir);
    }

}