class FileUrlGeneratorTest in Drupal 9
@coversDefaultClass \Drupal\Core\File\FileUrlGenerator
@group File
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\File\FileTestBase
- class \Drupal\KernelTests\Core\File\FileUrlGeneratorTest
- class \Drupal\KernelTests\Core\File\FileTestBase
Expanded class hierarchy of FileUrlGeneratorTest
File
- core/
tests/ Drupal/ KernelTests/ Core/ File/ FileUrlGeneratorTest.php, line 13
Namespace
Drupal\KernelTests\Core\FileView 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() {
$this
->expectException(InvalidStreamWrapperException::class);
$result = $this->fileUrlGenerator
->generate("foo://bar");
}
/**
* Tests missing stream handler.
*
* @covers ::generateString
*/
public function testGenerateStringMissingStreamWrapper() {
$this
->expectException(InvalidStreamWrapperException::class);
$result = $this->fileUrlGenerator
->generateString("foo://bar");
}
/**
* Tests missing stream handler.
*
* @covers ::generateAbsoluteString
*/
public function testGenerateAbsoluteStringMissingStreamWrapper() {
$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() {
// 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() {
// 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() {
// 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']);
$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) {
// 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']);
$this->container
->get('request_stack')
->push($request);
\Drupal::setContainer($this->container);
// No schema file.
$url = $this->fileUrlGenerator
->generate($filepath);
$this
->assertEquals($expected, $url
->getUri());
}
/**
* @covers ::generate
*/
public function testGenerateURIWithSchema() {
// 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']);
$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 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',
],
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FileTestBase:: |
protected | property | A fully-qualified stream wrapper class name to register for the test. | 9 |
FileTestBase:: |
protected | property | A stream wrapper scheme to register for the test. | 9 |
FileTestBase:: |
public | function | Helper function to test the permissions of a directory. | |
FileTestBase:: |
public | function | Helper function to test the permissions of a file. | |
FileTestBase:: |
public | function | Create a directory and assert it exists. | |
FileTestBase:: |
public | function | Create a file and return the URI of it. | |
FileTestBase:: |
public | function |
Registers test-specific services. Overrides KernelTestBase:: |
|
FileTestBase:: |
protected | function |
Sets up the filesystem, so things like the file directory. Overrides KernelTestBase:: |
|
FileUrlGeneratorTest:: |
protected | property | The file URL generator under test. | |
FileUrlGeneratorTest:: |
protected static | property |
Modules to enable. Overrides FileTestBase:: |
|
FileUrlGeneratorTest:: |
public | function | Data provider. | |
FileUrlGeneratorTest:: |
protected | function |
Overrides FileTestBase:: |
|
FileUrlGeneratorTest:: |
public | function | Tests missing stream handler. | |
FileUrlGeneratorTest:: |
public | function | Tests missing stream handler. | |
FileUrlGeneratorTest:: |
public | function | Tests missing stream handler. | |
FileUrlGeneratorTest:: |
public | function | @covers ::generate | |
FileUrlGeneratorTest:: |
public | function | @covers ::generate | |
FileUrlGeneratorTest:: |
public | function | Tests the rewriting of public managed file URLs by hook_file_url_alter(). | |
FileUrlGeneratorTest:: |
public | function | Tests generate absolute string with relative URL. | |
FileUrlGeneratorTest:: |
public | function | Tests the rewriting of shipped file URLs by hook_file_url_alter(). | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |