class HalLinkManagerTest

Same name in other branches
  1. 9 core/modules/hal/tests/src/Kernel/HalLinkManagerTest.php \Drupal\Tests\hal\Kernel\HalLinkManagerTest

@coversDefaultClass \Drupal\hal\LinkManager\LinkManager @group hal @group legacy

Hierarchy

Expanded class hierarchy of HalLinkManagerTest

File

core/modules/hal/tests/src/Kernel/HalLinkManagerTest.php, line 18

Namespace

Drupal\Tests\hal\Kernel
View source
class HalLinkManagerTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'hal',
        'hal_test',
        'serialization',
        'system',
        'node',
        'user',
        'field',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $this->installEntitySchema('node');
        NodeType::create([
            'type' => 'page',
        ])->save();
        FieldStorageConfig::create([
            'entity_type' => 'node',
            'type' => 'entity_reference',
            'field_name' => 'field_ref',
        ])->save();
        FieldConfig::create([
            'entity_type' => 'node',
            'bundle' => 'page',
            'field_name' => 'field_ref',
        ])->save();
        \Drupal::service('router.builder')->rebuild();
    }
    
    /**
     * @covers ::getTypeUri
     * @dataProvider providerTestGetTypeUri
     * @expectedDeprecation The deprecated alter hook hook_rest_type_uri_alter() is implemented in these functions: hal_test_rest_type_uri_alter. This hook is deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Implement hook_hal_type_uri_alter() instead.
     */
    public function testGetTypeUri($link_domain, $entity_type, $bundle, array $context, $expected_return, array $expected_context) {
        $hal_settings = \Drupal::configFactory()->getEditable('hal.settings');
        if ($link_domain === NULL) {
            $hal_settings->clear('link_domain');
        }
        else {
            $hal_settings->set('link_domain', $link_domain)
                ->save(TRUE);
        }
        
        /* @var \Drupal\rest\LinkManager\TypeLinkManagerInterface $type_manager */
        $type_manager = \Drupal::service('hal.link_manager.type');
        $link = $type_manager->getTypeUri($entity_type, $bundle, $context);
        $this->assertSame($link, str_replace('BASE_URL/', Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString(), $expected_return));
        $this->assertEquals($context, $expected_context);
    }
    public function providerTestGetTypeUri() {
        $serialization_context_collecting_cacheability = [
            CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => new CacheableMetadata(),
        ];
        $expected_serialization_context_cacheability_url_site = [
            CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => (new CacheableMetadata())->setCacheContexts([
                'url.site',
            ]),
        ];
        $base_test_case = [
            'link_domain' => NULL,
            'entity_type' => 'node',
            'bundle' => 'page',
        ];
        return [
            'site URL' => $base_test_case + [
                'context' => [],
                'link_domain' => NULL,
                'expected return' => 'BASE_URL/rest/type/node/page',
                'expected context' => [],
            ],
            'site URL, with optional context to collect cacheability metadata' => $base_test_case + [
                'context' => $serialization_context_collecting_cacheability,
                'expected return' => 'BASE_URL/rest/type/node/page',
                'expected context' => $expected_serialization_context_cacheability_url_site,
            ],
            // Test hook_hal_type_uri_alter().
'site URL, with optional context, to test hook_hal_type_uri_alter()' => $base_test_case + [
                'context' => [
                    'hal_test' => TRUE,
                ],
                'expected return' => 'hal_test_type',
                'expected context' => [
                    'hal_test' => TRUE,
                ],
            ],
            'site URL, with optional context, to test hook_hal_type_uri_alter(), and collecting cacheability metadata' => $base_test_case + [
                'context' => [
                    'hal_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
                'expected return' => 'hal_test_type',
                // No cacheability metadata bubbled.
'expected context' => [
                    'hal_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
            ],
            // Test hook_rest_type_uri_alter() — for backwards compatibility.
'site URL, with optional context, to test hook_rest_type_uri_alter()' => $base_test_case + [
                'context' => [
                    'rest_test' => TRUE,
                ],
                'expected return' => 'rest_test_type',
                'expected context' => [
                    'rest_test' => TRUE,
                ],
            ],
            'site URL, with optional context, to test hook_rest_type_uri_alter(), and collecting cacheability metadata' => $base_test_case + [
                'context' => [
                    'rest_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
                'expected return' => 'rest_test_type',
                // No cacheability metadata bubbled.
'expected context' => [
                    'rest_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
            ],
            'configured URL' => [
                'link_domain' => 'http://llamas-rock.com/for-real/',
                'entity_type' => 'node',
                'bundle' => 'page',
                'context' => [],
                'expected return' => 'http://llamas-rock.com/for-real/rest/type/node/page',
                'expected context' => [],
            ],
            'configured URL, with optional context to collect cacheability metadata' => [
                'link_domain' => 'http://llamas-rock.com/for-real/',
                'entity_type' => 'node',
                'bundle' => 'page',
                'context' => $serialization_context_collecting_cacheability,
                'expected return' => 'http://llamas-rock.com/for-real/rest/type/node/page',
                'expected context' => [
                    CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => (new CacheableMetadata())->setCacheTags([
                        'config:hal.settings',
                    ]),
                ],
            ],
        ];
    }
    
    /**
     * @covers ::getRelationUri
     * @dataProvider providerTestGetRelationUri
     * @expectedDeprecation The deprecated alter hook hook_rest_relation_uri_alter() is implemented in these functions: hal_test_rest_relation_uri_alter. This hook is deprecated in Drupal 8.3.x and will be removed before Drupal 9.0.0. Implement hook_hal_relation_uri_alter() instead.
     */
    public function testGetRelationUri($link_domain, $entity_type, $bundle, $field_name, array $context, $expected_return, array $expected_context) {
        $hal_settings = \Drupal::configFactory()->getEditable('hal.settings');
        if ($link_domain === NULL) {
            $hal_settings->clear('link_domain');
        }
        else {
            $hal_settings->set('link_domain', $link_domain)
                ->save(TRUE);
        }
        
        /* @var \Drupal\rest\LinkManager\RelationLinkManagerInterface $relation_manager */
        $relation_manager = \Drupal::service('hal.link_manager.relation');
        $link = $relation_manager->getRelationUri($entity_type, $bundle, $field_name, $context);
        $this->assertSame($link, str_replace('BASE_URL/', Url::fromRoute('<front>', [], [
            'absolute' => TRUE,
        ])->toString(), $expected_return));
        $this->assertEquals($context, $expected_context);
    }
    public function providerTestGetRelationUri() {
        $serialization_context_collecting_cacheability = [
            CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => new CacheableMetadata(),
        ];
        $expected_serialization_context_cacheability_url_site = [
            CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => (new CacheableMetadata())->setCacheContexts([
                'url.site',
            ]),
        ];
        $field_name = $this->randomMachineName();
        $base_test_case = [
            'link_domain' => NULL,
            'entity_type' => 'node',
            'bundle' => 'page',
            'field_name' => $field_name,
        ];
        return [
            'site URL' => $base_test_case + [
                'context' => [],
                'link_domain' => NULL,
                'expected return' => 'BASE_URL/rest/relation/node/page/' . $field_name,
                'expected context' => [],
            ],
            'site URL, with optional context to collect cacheability metadata' => $base_test_case + [
                'context' => $serialization_context_collecting_cacheability,
                'expected return' => 'BASE_URL/rest/relation/node/page/' . $field_name,
                'expected context' => $expected_serialization_context_cacheability_url_site,
            ],
            // Test hook_hal_relation_uri_alter().
'site URL, with optional context, to test hook_hal_relation_uri_alter()' => $base_test_case + [
                'context' => [
                    'hal_test' => TRUE,
                ],
                'expected return' => 'hal_test_relation',
                'expected context' => [
                    'hal_test' => TRUE,
                ],
            ],
            'site URL, with optional context, to test hook_hal_relation_uri_alter(), and collecting cacheability metadata' => $base_test_case + [
                'context' => [
                    'hal_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
                'expected return' => 'hal_test_relation',
                // No cacheability metadata bubbled.
'expected context' => [
                    'hal_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
            ],
            // Test hook_rest_relation_uri_alter() — for backwards compatibility.
'site URL, with optional context, to test hook_rest_relation_uri_alter()' => $base_test_case + [
                'context' => [
                    'rest_test' => TRUE,
                ],
                'expected return' => 'rest_test_relation',
                'expected context' => [
                    'rest_test' => TRUE,
                ],
            ],
            'site URL, with optional context, to test hook_rest_relation_uri_alter(), and collecting cacheability metadata' => $base_test_case + [
                'context' => [
                    'rest_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
                'expected return' => 'rest_test_relation',
                // No cacheability metadata bubbled.
'expected context' => [
                    'rest_test' => TRUE,
                ] + $serialization_context_collecting_cacheability,
            ],
            'configured URL' => [
                'link_domain' => 'http://llamas-rock.com/for-real/',
                'entity_type' => 'node',
                'bundle' => 'page',
                'field_name' => $field_name,
                'context' => [],
                'expected return' => 'http://llamas-rock.com/for-real/rest/relation/node/page/' . $field_name,
                'expected context' => [],
            ],
            'configured URL, with optional context to collect cacheability metadata' => [
                'link_domain' => 'http://llamas-rock.com/for-real/',
                'entity_type' => 'node',
                'bundle' => 'page',
                'field_name' => $field_name,
                'context' => $serialization_context_collecting_cacheability,
                'expected return' => 'http://llamas-rock.com/for-real/rest/relation/node/page/' . $field_name,
                'expected context' => [
                    CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => (new CacheableMetadata())->setCacheTags([
                        'config:hal.settings',
                    ]),
                ],
            ],
        ];
    }
    
    /**
     * @covers ::getRelationInternalIds
     */
    public function testGetRelationInternalIds() {
        
        /* @var \Drupal\rest\LinkManager\RelationLinkManagerInterface $relation_manager */
        $relation_manager = \Drupal::service('hal.link_manager.relation');
        $link = $relation_manager->getRelationUri('node', 'page', 'field_ref');
        $internal_ids = $relation_manager->getRelationInternalIds($link);
        $this->assertEquals([
            'entity_type_id' => 'node',
            'entity_type' => \Drupal::entityTypeManager()->getDefinition('node'),
            'bundle' => 'page',
            'field_name' => 'field_ref',
        ], $internal_ids);
    }
    
    /**
     * @covers ::setLinkDomain
     */
    public function testHalLinkManagersSetLinkDomain() {
        $serialization_context = [
            CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY => new CacheableMetadata(),
        ];
        
        /* @var \Drupal\rest\LinkManager\LinkManager $link_manager */
        $link_manager = \Drupal::service('hal.link_manager');
        $link_manager->setLinkDomain('http://example.com/');
        $link = $link_manager->getTypeUri('node', 'page', $serialization_context);
        $this->assertEqual($link, 'http://example.com/rest/type/node/page');
        $this->assertEqual(new CacheableMetadata(), $serialization_context[CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY]);
        $link = $link_manager->getRelationUri('node', 'page', 'field_ref', $serialization_context);
        $this->assertEqual($link, 'http://example.com/rest/relation/node/page/field_ref');
        $this->assertEqual(new CacheableMetadata(), $serialization_context[CacheableNormalizerInterface::SERIALIZATION_CONTEXT_CACHEABILITY]);
    }

}

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 the raw text IS NOT found escaped on the 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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
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.
HalLinkManagerTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
HalLinkManagerTest::providerTestGetRelationUri public function
HalLinkManagerTest::providerTestGetTypeUri public function
HalLinkManagerTest::setUp protected function Overrides KernelTestBase::setUp
HalLinkManagerTest::testGetRelationInternalIds public function @covers ::getRelationInternalIds
HalLinkManagerTest::testGetRelationUri public function @covers ::getRelationUri
@dataProvider providerTestGetRelationUri
@expectedDeprecation The deprecated alter hook hook_rest_relation_uri_alter() is implemented in these functions: hal_test_rest_relation_uri_alter. This hook is deprecated in Drupal…
HalLinkManagerTest::testGetTypeUri public function @covers ::getTypeUri
@dataProvider providerTestGetTypeUri
@expectedDeprecation The deprecated alter hook hook_rest_type_uri_alter() is implemented in these functions: hal_test_rest_type_uri_alter. This hook is deprecated in Drupal 8.3.x and will be…
HalLinkManagerTest::testHalLinkManagersSetLinkDomain public function @covers ::setLinkDomain
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. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
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. 6
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 private function Bootstraps a kernel for a test.
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.
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. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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 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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
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.