class LinkItemUrlValidationTest

Same name in other branches
  1. 9 core/modules/link/tests/src/Kernel/LinkItemUrlValidationTest.php \Drupal\Tests\link\Kernel\LinkItemUrlValidationTest
  2. 10 core/modules/link/tests/src/Kernel/LinkItemUrlValidationTest.php \Drupal\Tests\link\Kernel\LinkItemUrlValidationTest

Tests link field validation.

@group link

Hierarchy

Expanded class hierarchy of LinkItemUrlValidationTest

File

core/modules/link/tests/src/Kernel/LinkItemUrlValidationTest.php, line 14

Namespace

Drupal\Tests\link\Kernel
View source
class LinkItemUrlValidationTest extends FieldKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'link',
    ];
    
    /**
     * Tests link validation.
     */
    public function testExternalLinkValidation() : void {
        $definition = \Drupal::typedDataManager()->createDataDefinition('field_item:link');
        $link_item = \Drupal::typedDataManager()->create($definition);
        $test_links = $this->getTestLinks();
        foreach ($test_links as $data) {
            [
                $value,
                $expected_violations,
            ] = $data;
            $link_item->setValue($value);
            $violations = $link_item->validate();
            $expected_count = count($expected_violations);
            $this->assertCount($expected_count, $violations, sprintf('Violation message count error for %s', $value));
            if ($expected_count) {
                $i = 0;
                foreach ($expected_violations as $error_msg) {
                    // If the expected message contains a '%' add the current link value.
                    if (strpos($error_msg, '%')) {
                        $error_msg = sprintf($error_msg, $value);
                    }
                    $this->assertEquals($error_msg, $violations[$i++]->getMessage());
                }
            }
        }
    }
    
    /**
     * Builds an array of links to test.
     *
     * @return array
     *   The first element of the array is the link value to test. The second
     *   value is an array of expected violation messages.
     */
    protected function getTestLinks() : array {
        $violation_0 = "The path '%s' is invalid.";
        $violation_1 = 'This value should be of the correct primitive type.';
        return [
            [
                'invalid://not-a-valid-protocol',
                [
                    $violation_0,
                ],
            ],
            [
                'http://www.example.com/',
                [],
            ],
            // Strings within parenthesis without leading space char.
[
                'http://www.example.com/strings_(string_within_parenthesis)',
                [],
            ],
            // Numbers within parenthesis without leading space char.
[
                'http://www.example.com/numbers_(9999)',
                [],
            ],
            [
                'http://www.example.com/?name=ferret&color=purple',
                [],
            ],
            [
                'http://www.example.com/page?name=ferret&color=purple',
                [],
            ],
            [
                'http://www.example.com?a=&b[]=c&d[]=e&d[]=f&h==',
                [],
            ],
            [
                'http://www.example.com#colors',
                [],
            ],
            // Use list of valid URLS from],
            // https://cran.r-project.org/web/packages/rex/vignettes/url_parsing.html.
[
                "http://foo.com/blah_blah",
                [],
            ],
            [
                "http://foo.com/blah_blah/",
                [],
            ],
            [
                "http://foo.com/blah_blah_(wikipedia)",
                [],
            ],
            [
                "http://foo.com/blah_blah_(wikipedia)_(again)",
                [],
            ],
            [
                "http://www.example.com/wpstyle/?p=364",
                [],
            ],
            [
                "https://www.example.com/foo/?bar=baz&inga=42&quux",
                [],
            ],
            [
                "http://✪df.ws/123",
                [],
            ],
            [
                "http://userid:password@example.com:8080",
                [],
            ],
            [
                "http://userid:password@example.com:8080/",
                [],
            ],
            [
                "http://userid@example.com",
                [],
            ],
            [
                "http://userid@example.com/",
                [],
            ],
            [
                "http://userid@example.com:8080",
                [],
            ],
            [
                "http://userid@example.com:8080/",
                [],
            ],
            [
                "http://userid:password@example.com",
                [],
            ],
            [
                "http://userid:password@example.com/",
                [],
            ],
            [
                "http://➡.ws/䨹",
                [],
            ],
            [
                "http://⌘.ws",
                [],
            ],
            [
                "http://⌘.ws/",
                [],
            ],
            [
                "http://foo.com/blah_(wikipedia)#cite-1",
                [],
            ],
            [
                "http://foo.com/blah_(wikipedia)_blah#cite-1",
                [],
            ],
            // The following invalid URLs produce false positives.
[
                "http://foo.com/unicode_(✪)_in_parens",
                [],
            ],
            [
                "http://foo.com/(something)?after=parens",
                [],
            ],
            [
                "http://☺.damowmow.com/",
                [],
            ],
            [
                "http://code.google.com/events/#&product=browser",
                [],
            ],
            [
                "http://j.mp",
                [],
            ],
            [
                "ftp://foo.bar/baz",
                [],
            ],
            [
                "http://foo.bar/?q=Test%20URL-encoded%20stuff",
                [],
            ],
            [
                "http://مثال.إختبار",
                [],
            ],
            [
                "http://例子.测试",
                [],
            ],
            [
                "http://-.~_!\$&'()*+,;=:%40:80%2f::::::@example.com",
                [],
            ],
            [
                "http://1337.net",
                [],
            ],
            [
                "http://a.b-c.de",
                [],
            ],
            [
                "radar://1234",
                [
                    $violation_0,
                ],
            ],
            [
                "h://test",
                [
                    $violation_0,
                ],
            ],
            [
                "ftps://foo.bar/",
                [
                    $violation_0,
                ],
            ],
            // Use invalid URLS from
            // https://cran.r-project.org/web/packages/rex/vignettes/url_parsing.html.
[
                'http://',
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://?",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://??",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://??/",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://#",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://##",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http://##/",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "//",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "///a",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "///",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
            [
                "http:///a",
                [
                    $violation_0,
                    $violation_1,
                ],
            ],
        ];
    }

}

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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::setUp protected function Set the default field storage backend for fields created during tests. Overrides KernelTestBase::setUp 31
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
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. 2
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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
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::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
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.
LinkItemUrlValidationTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules
LinkItemUrlValidationTest::getTestLinks protected function Builds an array of links to test.
LinkItemUrlValidationTest::testExternalLinkValidation public function Tests link validation.
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.