class FileTestBase

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/File/FileTestBase.php \Drupal\KernelTests\Core\File\FileTestBase
  2. 8.9.x core/tests/Drupal/KernelTests/Core/File/FileTestBase.php \Drupal\KernelTests\Core\File\FileTestBase
  3. 10 core/tests/Drupal/KernelTests/Core/File/FileTestBase.php \Drupal\KernelTests\Core\File\FileTestBase

Provides file-specific assertions and helper functions.

Hierarchy

Expanded class hierarchy of FileTestBase

3 files declare their use of FileTestBase
ArchiverTestBase.php in core/tests/Drupal/KernelTests/Core/Archiver/ArchiverTestBase.php
DownloadTest.php in core/modules/migrate/tests/src/Kernel/process/DownloadTest.php
FileCopyTest.php in core/modules/migrate/tests/src/Kernel/process/FileCopyTest.php

File

core/tests/Drupal/KernelTests/Core/File/FileTestBase.php, line 13

Namespace

Drupal\KernelTests\Core\File
View source
abstract class FileTestBase extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
    ];
    
    /**
     * A stream wrapper scheme to register for the test.
     *
     * @var string
     */
    protected $scheme;
    
    /**
     * A fully-qualified stream wrapper class name to register for the test.
     *
     * @var string
     */
    protected $classname;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // \Drupal\KernelTests\KernelTestBase::bootKernel() sets a global override
        // for the default scheme because core relies on it in
        // file_default_scheme(). As we are creating the configuration here remove
        // the global override.
        unset($GLOBALS['config']['system.file']);
        \Drupal::configFactory()->getEditable('system.file')
            ->set('default_scheme', 'public')
            ->save();
    }
    
    /**
     * {@inheritdoc}
     */
    public function register(ContainerBuilder $container) {
        parent::register($container);
        $container->register('stream_wrapper.private', 'Drupal\\Core\\StreamWrapper\\PrivateStream')
            ->addTag('stream_wrapper', [
            'scheme' => 'private',
        ]);
        if (isset($this->scheme)) {
            $container->register('stream_wrapper.' . $this->scheme, $this->classname)
                ->addTag('stream_wrapper', [
                'scheme' => $this->scheme,
            ]);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function setUpFilesystem() {
        $public_file_directory = $this->siteDirectory . '/files';
        $private_file_directory = $this->siteDirectory . '/private';
        mkdir($this->siteDirectory, 0775);
        mkdir($this->siteDirectory . '/files', 0775);
        mkdir($this->siteDirectory . '/private', 0775);
        mkdir($this->siteDirectory . '/files/config/sync', 0775, TRUE);
        $this->setSetting('file_public_path', $public_file_directory);
        $this->setSetting('file_private_path', $private_file_directory);
        $this->setSetting('config_sync_directory', $this->siteDirectory . '/files/config/sync');
    }
    
    /**
     * Helper function to test the permissions of a file.
     *
     * @param $filepath
     *   String file path.
     * @param $expected_mode
     *   Octal integer like 0664 or 0777.
     * @param $message
     *   Optional message.
     */
    public function assertFilePermissions($filepath, $expected_mode, $message = NULL) {
        // Clear out PHP's file stat cache to be sure we see the current value.
        clearstatcache(TRUE, $filepath);
        // Mask out all but the last three octets.
        $actual_mode = fileperms($filepath) & 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 (str_starts_with(PHP_OS, '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;
        }
        if (!isset($message)) {
            $message = sprintf('Expected file permission to be %s, actually were %s.', decoct($actual_mode), decoct($expected_mode));
        }
        $this->assertEquals($expected_mode, $actual_mode, $message);
    }
    
    /**
     * Helper function to test the permissions of a directory.
     *
     * @param $directory
     *   String directory path.
     * @param $expected_mode
     *   Octal integer like 0664 or 0777.
     * @param $message
     *   Optional message.
     */
    public function assertDirectoryPermissions($directory, $expected_mode, $message = NULL) {
        // Clear out PHP's file stat cache to be sure we see the current value.
        clearstatcache(TRUE, $directory);
        // Mask out all but the last three octets.
        $actual_mode = fileperms($directory) & 0777;
        $expected_mode = $expected_mode & 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 (str_starts_with(PHP_OS, '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;
        }
        if (!isset($message)) {
            $message = sprintf('Expected directory permission to be %s, actually were %s.', decoct($expected_mode), decoct($actual_mode));
        }
        $this->assertEquals($expected_mode, $actual_mode, $message);
    }
    
    /**
     * Create a directory and assert it exists.
     *
     * @param string $path
     *   Optional string with a directory path. If none is provided, a random
     *   name in the site's files directory will be used.
     *
     * @return string
     *   The path to the directory.
     */
    public function createDirectory($path = NULL) {
        // A directory to operate on.
        if (!isset($path)) {
            $path = 'public://' . $this->randomMachineName();
        }
        $this->assertTrue(\Drupal::service('file_system')->mkdir($path));
        $this->assertDirectoryExists($path);
        return $path;
    }
    
    /**
     * Create a file and return the URI of it.
     *
     * @param $filepath
     *   Optional string specifying the file path. If none is provided then a
     *   randomly named file will be created in the site's files directory.
     * @param $contents
     *   Optional contents to save into the file. If a NULL value is provided an
     *   arbitrary string will be used.
     * @param $scheme
     *   Optional string indicating the stream scheme to use. Drupal core includes
     *   public, private, and temporary. The public wrapper is the default.
     *
     * @return string
     *   File URI.
     */
    public function createUri($filepath = NULL, $contents = NULL, $scheme = NULL) {
        if (!isset($filepath)) {
            // Prefix with non-latin characters to ensure that all file-related
            // tests work with international filenames.
            // cSpell:disable-next-line
            $filepath = 'Файл для тестирования ' . $this->randomMachineName();
        }
        if (!isset($scheme)) {
            $scheme = 'public';
        }
        $filepath = $scheme . '://' . $filepath;
        if (!isset($contents)) {
            $contents = "file_put_contents() doesn't seem to appreciate empty strings so let's put in some data.";
        }
        file_put_contents($filepath, $contents);
        $this->assertFileExists($filepath);
        return $filepath;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FileTestBase::$classname protected property A fully-qualified stream wrapper class name to register for the test. 9
FileTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 12
FileTestBase::$scheme protected property A stream wrapper scheme to register for the test. 9
FileTestBase::assertDirectoryPermissions public function Helper function to test the permissions of a directory.
FileTestBase::assertFilePermissions public function Helper function to test the permissions of a file.
FileTestBase::createDirectory public function Create a directory and assert it exists.
FileTestBase::createUri public function Create a file and return the URI of it.
FileTestBase::register public function Registers test-specific services. Overrides KernelTestBase::register
FileTestBase::setUp protected function Overrides KernelTestBase::setUp 13
FileTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. Overrides KernelTestBase::setUpFilesystem
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.