class FileUrlGeneratorTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/File/FileUrlGeneratorTest.php \Drupal\KernelTests\Core\File\FileUrlGeneratorTest
  2. 11.x core/tests/Drupal/KernelTests/Core/File/FileUrlGeneratorTest.php \Drupal\KernelTests\Core\File\FileUrlGeneratorTest

@coversDefaultClass \Drupal\Core\File\FileUrlGenerator

@group File

Hierarchy

Expanded class hierarchy of FileUrlGeneratorTest

File

core/tests/Drupal/KernelTests/Core/File/FileUrlGeneratorTest.php, line 17

Namespace

Drupal\KernelTests\Core\File
View source
class FileUrlGeneratorTest extends FileTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'file_test',
    ];
    
    /**
     * The file URL generator under test.
     *
     * @var \Drupal\Core\File\FileUrlGenerator
     */
    protected $fileUrlGenerator;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->fileUrlGenerator = $this->container
            ->get('file_url_generator');
    }
    
    /**
     * Tests missing stream handler.
     *
     * @covers ::generate
     */
    public function testGenerateMissingStreamWrapper() : void {
        $this->expectException(InvalidStreamWrapperException::class);
        $result = $this->fileUrlGenerator
            ->generate("foo://bar");
    }
    
    /**
     * Tests missing stream handler.
     *
     * @covers ::generateString
     */
    public function testGenerateStringMissingStreamWrapper() : void {
        $this->expectException(InvalidStreamWrapperException::class);
        $result = $this->fileUrlGenerator
            ->generateString("foo://bar");
    }
    
    /**
     * Tests missing stream handler.
     *
     * @covers ::generateAbsoluteString
     */
    public function testGenerateAbsoluteStringMissingStreamWrapper() : void {
        $this->expectException(InvalidStreamWrapperException::class);
        $result = $this->fileUrlGenerator
            ->generateAbsoluteString("foo://bar");
    }
    
    /**
     * Tests the rewriting of shipped file URLs by hook_file_url_alter().
     *
     * @covers ::generateAbsoluteString
     */
    public function testShippedFileURL() : void {
        // Test generating a URL to a shipped file (i.e. a file that is part of
        // Drupal core, a module or a theme, for example a JavaScript file).
        // Test alteration of file URLs to use a CDN.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'cdn');
        $filepath = 'core/assets/vendor/jquery/jquery.min.js';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals(FILE_URL_TEST_CDN_1 . '/' . $filepath, $url, 'Correctly generated a CDN URL for a shipped file.');
        $filepath = 'core/misc/favicon.ico';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals(FILE_URL_TEST_CDN_2 . '/' . $filepath, $url, 'Correctly generated a CDN URL for a shipped file.');
        // Test alteration of file URLs to use root-relative URLs.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'root-relative');
        $filepath = 'core/assets/vendor/jquery/jquery.min.js';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals(base_path() . '/' . $filepath, $url, 'Correctly generated a root-relative URL for a shipped file.');
        $filepath = 'core/misc/favicon.ico';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals(base_path() . '/' . $filepath, $url, 'Correctly generated a root-relative URL for a shipped file.');
        // Test alteration of file URLs to use protocol-relative URLs.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'protocol-relative');
        $filepath = 'core/assets/vendor/jquery/jquery.min.js';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals('/' . base_path() . '/' . $filepath, $url, 'Correctly generated a protocol-relative URL for a shipped file.');
        $filepath = 'core/misc/favicon.ico';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertEquals('/' . base_path() . '/' . $filepath, $url, 'Correctly generated a protocol-relative URL for a shipped file.');
        // Test alteration of file URLs with query strings and/or fragment.
        \Drupal::state()->delete('file_test.hook_file_url_alter');
        $filepath = 'core/misc/favicon.ico';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath . '?foo');
        $this->assertEquals($GLOBALS['base_url'] . '/' . $filepath . '?foo=', $url, 'Correctly generated URL. The query string is present.');
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath . '?foo=bar');
        $this->assertEquals($GLOBALS['base_url'] . '/' . $filepath . '?foo=bar', $url, 'Correctly generated URL. The query string is present.');
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath . '#v1.2');
        $this->assertEquals($GLOBALS['base_url'] . '/' . $filepath . '#v1.2', $url, 'Correctly generated URL. The fragment is present.');
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath . '?foo=bar#v1.2');
        $this->assertEquals($GLOBALS['base_url'] . '/' . $filepath . '?foo=bar#v1.2', $url, 'Correctly generated URL. The query string amd fragment is present.');
    }
    
    /**
     * Tests the rewriting of public managed file URLs by hook_file_url_alter().
     *
     * @covers ::generateAbsoluteString
     */
    public function testPublicManagedFileURL() : void {
        // Test generating a URL to a managed file.
        // Test alteration of file URLs to use a CDN.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'cdn');
        $uri = $this->createUri();
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($uri);
        $public_directory_path = \Drupal::service('stream_wrapper_manager')->getViaScheme('public')
            ->getDirectoryPath();
        
        /** @var \Drupal\Core\File\FileSystemInterface $file_system */
        $file_system = \Drupal::service('file_system');
        $this->assertEquals(FILE_URL_TEST_CDN_2 . '/' . $public_directory_path . '/' . $file_system->basename($uri), $url, 'Correctly generated a CDN URL for a created file.');
        // Test alteration of file URLs to use root-relative URLs.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'root-relative');
        $uri = $this->createUri();
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($uri);
        $this->assertEquals(base_path() . '/' . $public_directory_path . '/' . $file_system->basename($uri), $url, 'Correctly generated a root-relative URL for a created file.');
        // Test alteration of file URLs to use a protocol-relative URLs.
        \Drupal::state()->set('file_test.hook_file_url_alter', 'protocol-relative');
        $uri = $this->createUri();
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($uri);
        $this->assertEquals('/' . base_path() . '/' . $public_directory_path . '/' . $file_system->basename($uri), $url, 'Correctly generated a protocol-relative URL for a created file.');
    }
    
    /**
     * Tests generate absolute string with relative URL.
     *
     * @covers ::generateAbsoluteString
     */
    public function testRelativeFileURL() : void {
        // Disable file_test.module's hook_file_url_alter() implementation.
        \Drupal::state()->set('file_test.hook_file_url_alter', NULL);
        // Create a mock Request for transformRelative().
        $request = Request::create($GLOBALS['base_url']);
        $request->setSession(new Session(new MockArraySessionStorage()));
        $this->container
            ->get('request_stack')
            ->push($request);
        \Drupal::setContainer($this->container);
        // Shipped file.
        $filepath = 'core/assets/vendor/jquery/jquery.min.js';
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($filepath);
        $this->assertSame(base_path() . $filepath, $this->fileUrlGenerator
            ->transformRelative($url));
        // Managed file.
        $uri = $this->createUri();
        $url = $this->fileUrlGenerator
            ->generateAbsoluteString($uri);
        $public_directory_path = \Drupal::service('stream_wrapper_manager')->getViaScheme('public')
            ->getDirectoryPath();
        $this->assertSame(base_path() . $public_directory_path . '/' . rawurlencode(\Drupal::service('file_system')->basename($uri)), $this->fileUrlGenerator
            ->transformRelative($url));
    }
    
    /**
     * @covers ::generate
     *
     * @dataProvider providerGenerateURI
     */
    public function testGenerateURI($filepath, $expected) : void {
        // Disable file_test.module's hook_file_url_alter() implementation.
        \Drupal::state()->set('file_test.hook_file_url_alter', NULL);
        // Create a mock Request for transformRelative().
        $request = Request::create($GLOBALS['base_url']);
        $request->setSession(new Session(new MockArraySessionStorage()));
        $this->container
            ->get('request_stack')
            ->push($request);
        \Drupal::setContainer($this->container);
        // No schema file.
        $url = $this->fileUrlGenerator
            ->generate($filepath);
        $this->assertEquals($expected, $url->toUriString());
    }
    
    /**
     * @covers ::generate
     */
    public function testGenerateURIWithSchema() : void {
        // Disable file_test.module's hook_file_url_alter() implementation.
        \Drupal::state()->set('file_test.hook_file_url_alter', NULL);
        // Create a mock Request for transformRelative().
        $request = Request::create($GLOBALS['base_url']);
        $request->setSession(new Session(new MockArraySessionStorage()));
        $this->container
            ->get('request_stack')
            ->push($request);
        \Drupal::setContainer($this->container);
        $public_directory_path = \Drupal::service('stream_wrapper_manager')->getViaScheme('public')
            ->getDirectoryPath();
        $url = $this->fileUrlGenerator
            ->generate('public://path/to/file.png');
        $this->assertEquals('base:/' . $public_directory_path . '/path/to/file.png', $url->getUri());
    }
    
    /**
     * Data provider.
     */
    public static function providerGenerateURI() {
        return [
            'schemaless' => [
                '//core/assets/vendor/jquery/jquery.min.js',
                '//core/assets/vendor/jquery/jquery.min.js',
            ],
            'query string' => [
                '//core/assets/vendor/jquery/jquery.min.js?foo',
                '//core/assets/vendor/jquery/jquery.min.js?foo',
            ],
            'query string and hashes' => [
                '//core/assets/vendor/jquery/jquery.min.js?foo=bar#whizz',
                '//core/assets/vendor/jquery/jquery.min.js?foo=bar#whizz',
            ],
            'hashes' => [
                '//core/assets/vendor/jquery/jquery.min.js#whizz',
                '//core/assets/vendor/jquery/jquery.min.js#whizz',
            ],
            'root-relative' => [
                '/core/assets/vendor/jquery/jquery.min.js',
                'base:/core/assets/vendor/jquery/jquery.min.js',
            ],
            'relative' => [
                'core/assets/vendor/jquery/jquery.min.js',
                'base:core/assets/vendor/jquery/jquery.min.js',
            ],
            'external' => [
                'https://www.example.com/core/assets/vendor/jquery/jquery.min.js',
                'https://www.example.com/core/assets/vendor/jquery/jquery.min.js',
            ],
            'external stream wrapper' => [
                'dummy-external-readonly://core/assets/vendor/jquery/jquery.min.js',
                'https://www.dummy-external-readonly.com/core/assets/vendor/jquery/jquery.min.js',
            ],
            'external stream wrapper with query string' => [
                'dummy-external-readonly://core/assets/vendor/jquery/jquery.min.js?foo=bar',
                'https://www.dummy-external-readonly.com/core/assets/vendor/jquery/jquery.min.js?foo=bar',
            ],
            'external stream wrapper with hashes' => [
                'dummy-external-readonly://core/assets/vendor/jquery/jquery.min.js#whizz',
                'https://www.dummy-external-readonly.com/core/assets/vendor/jquery/jquery.min.js#whizz',
            ],
            'external stream wrapper with query string and hashes' => [
                'dummy-external-readonly://core/assets/vendor/jquery/jquery.min.js?foo=bar#whizz',
                'https://www.dummy-external-readonly.com/core/assets/vendor/jquery/jquery.min.js?foo=bar#whizz',
            ],
        ];
    }

}

Members

Title Sort descending Deprecated 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.
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::$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::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. Overrides KernelTestBase::setUpFilesystem
FileUrlGeneratorTest::$fileUrlGenerator protected property The file URL generator under test.
FileUrlGeneratorTest::$modules protected static property Modules to install. Overrides FileTestBase::$modules
FileUrlGeneratorTest::providerGenerateURI public static function Data provider.
FileUrlGeneratorTest::setUp protected function Overrides FileTestBase::setUp
FileUrlGeneratorTest::testGenerateAbsoluteStringMissingStreamWrapper public function Tests missing stream handler.
FileUrlGeneratorTest::testGenerateMissingStreamWrapper public function Tests missing stream handler.
FileUrlGeneratorTest::testGenerateStringMissingStreamWrapper public function Tests missing stream handler.
FileUrlGeneratorTest::testGenerateURI public function @covers ::generate
FileUrlGeneratorTest::testGenerateURIWithSchema public function @covers ::generate
FileUrlGeneratorTest::testPublicManagedFileURL public function Tests the rewriting of public managed file URLs by hook_file_url_alter().
FileUrlGeneratorTest::testRelativeFileURL public function Tests generate absolute string with relative URL.
FileUrlGeneratorTest::testShippedFileURL public function Tests the rewriting of shipped file URLs by hook_file_url_alter().
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
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. 7
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::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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.