You are here

class MicrositeMenuItemsTest in Entity Reference Hierarchy 3.x

Same name and namespace in other branches
  1. 8.2 modules/entity_hierarchy_microsite/tests/src/Kernel/MicrositeMenuItemsTest.php \Drupal\Tests\entity_hierarchy_microsite\Kernel\MicrositeMenuItemsTest

Defines a class for testing microsite menu items.

@group entity_hierarchy_microsite

Hierarchy

Expanded class hierarchy of MicrositeMenuItemsTest

File

modules/entity_hierarchy_microsite/tests/src/Kernel/MicrositeMenuItemsTest.php, line 13

Namespace

Drupal\Tests\entity_hierarchy_microsite\Kernel
View source
class MicrositeMenuItemsTest extends EntityHierarchyMicrositeKernelTestBase {

  /**
   * Tests the microsite menu link integration.
   */
  public function testMicrositeMenuLinkDerivation() {
    $media = $this
      ->createImageMedia();
    $children = $this
      ->createChildEntities($this->parent
      ->id(), 5);
    list($first, $second) = array_values($children);
    $first_children = $this
      ->createChildEntities($first
      ->id(), 5, '1.');
    $second_children = $this
      ->createChildEntities($second
      ->id(), 4, '2.');
    $microsite = Microsite::create([
      'name' => 'Subsite',
      'home' => $this->parent,
      'logo' => $media,
    ]);
    $microsite
      ->save();

    // hook_entity_hierarchy_microsite_links_alter() should be fired.
    $this
      ->assertEquals('success', \Drupal::state()
      ->get('entity_hierarchy_microsite_test_entity_hierarchy_microsite_links_alter', NULL));

    /** @var \Drupal\Core\Menu\MenuLinkTreeInterface $tree */
    $tree = \Drupal::service('menu.link_tree');
    $params = $tree
      ->getCurrentRouteMenuTreeParameters('entity-hierarchy-microsite');
    $params
      ->setMaxDepth(9);
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $this
      ->assertCount(1, $items);
    $plugin_id = 'entity_hierarchy_microsite:' . $this->parent
      ->uuid();
    $this
      ->assertArrayHasKey($plugin_id, $items);
    $this
      ->assertCount(5, $items[$plugin_id]->subtree);
    foreach ($children as $entity) {
      $child_plugin_id = 'entity_hierarchy_microsite:' . $entity
        ->uuid();
      $this
        ->assertArrayHasKey($child_plugin_id, $items[$plugin_id]->subtree);
      if ($entity
        ->uuid() === $first
        ->uuid()) {
        $this
          ->assertCount(5, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
        foreach ($first_children as $child_entity) {
          $this
            ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
            ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
        }
      }
      if ($entity
        ->uuid() === $second
        ->uuid()) {
        $this
          ->assertCount(4, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
        foreach ($second_children as $child_entity) {
          $this
            ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
            ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
        }
      }
    }

    /** @var \Drupal\node\NodeInterface $last */
    $last = array_pop($second_children);
    array_push($first_children, $last);
    $last->{self::FIELD_NAME} = $first;
    $last
      ->save();
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $child_plugin_id = 'entity_hierarchy_microsite:' . $first
      ->uuid();
    $this
      ->assertCount(6, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    foreach ($first_children as $child_entity) {
      $this
        ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
        ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    }
    $child_plugin_id = 'entity_hierarchy_microsite:' . $second
      ->uuid();
    $this
      ->assertCount(3, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    foreach ($second_children as $child_entity) {
      $this
        ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
        ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    }
    $last = array_pop($second_children);

    // Create a new revision.
    $last->{self::FIELD_NAME} = NULL;
    $last
      ->setNewRevision(TRUE);
    $last
      ->save();
    $last
      ->delete();
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $this
      ->assertCount(2, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    foreach ($second_children as $child_entity) {
      $this
        ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
        ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    }

    // Update child and make sure no items have been re-parented.
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $this
      ->assertCount(5, $items[$plugin_id]->subtree);
    $first
      ->set('title', 'Updated first title')
      ->setNewRevision();
    $first
      ->save();
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $this
      ->assertCount(5, $items[$plugin_id]->subtree);
    $lastChildOfSecond = end($second_children);
    $override1 = MicrositeMenuItemOverride::create([
      'target' => $lastChildOfSecond
        ->uuid(),
      'enabled' => FALSE,
      'weight' => 1000,
      'title' => $lastChildOfSecond
        ->label(),
      'parent' => 'entity_hierarchy_microsite:' . $second
        ->uuid(),
    ]);
    $override1
      ->save();
    $moved = reset($second_children);
    $override2 = MicrositeMenuItemOverride::create([
      'target' => $moved
        ->uuid(),
      'weight' => -1000,
      'title' => 'Some other title',
      'parent' => 'entity_hierarchy_microsite:' . $first
        ->uuid(),
    ]);
    $override2
      ->save();
    $items = $tree
      ->load('entity-hierarchy-microsite', $params);
    $child_plugin_id = 'entity_hierarchy_microsite:' . $first
      ->uuid();
    $this
      ->assertCount(7, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    foreach ($first_children as $child_entity) {
      $this
        ->assertArrayHasKey('entity_hierarchy_microsite:' . $child_entity
        ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    }
    $this
      ->assertArrayHasKey('entity_hierarchy_microsite:' . $moved
      ->uuid(), $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    $this
      ->assertEquals('Some other title', $items[$plugin_id]->subtree[$child_plugin_id]->subtree['entity_hierarchy_microsite:' . $moved
      ->uuid()]->link
      ->getTitle());
    $this
      ->assertEquals('-1000', $items[$plugin_id]->subtree[$child_plugin_id]->subtree['entity_hierarchy_microsite:' . $moved
      ->uuid()]->link
      ->getWeight());
    $child_plugin_id = 'entity_hierarchy_microsite:' . $second
      ->uuid();
    $this
      ->assertCount(1, $items[$plugin_id]->subtree[$child_plugin_id]->subtree);
    $this
      ->assertFalse((bool) $items[$plugin_id]->subtree[$child_plugin_id]->subtree['entity_hierarchy_microsite:' . $lastChildOfSecond
      ->uuid()]->link
      ->isEnabled());
    $this
      ->assertEquals('some-data', $items[$plugin_id]->subtree[$child_plugin_id]->subtree['entity_hierarchy_microsite:' . $lastChildOfSecond
      ->uuid()]->link
      ->getUrlObject()
      ->getOption('attributes')['data-some-data']);
  }

  /**
   * Tests microsite menus do not exceed the maximum depth.
   */
  public function testMicrositeMenuLinkMaxDepth() {

    /** @var \Drupal\Core\Menu\MenuLinkTreeInterface $menu_link_tree */
    $menu_link_tree = \Drupal::service('menu.link_tree');
    $menu_max_depth = $menu_link_tree
      ->maxDepth();
    $entity_max_depth = $menu_max_depth + 1;
    $media = $this
      ->createImageMedia();
    $parent_id = $this->parent
      ->id();
    for ($i = 1; $i <= $entity_max_depth; $i++) {
      $child = $this
        ->createTestEntity($parent_id, 1, "{$i}.");
      $parent_id = $child
        ->id();
    }
    $microsite = Microsite::create([
      'name' => 'Subsite',
      'home' => $this->parent,
      'logo' => $media,
    ]);
    $microsite
      ->save();

    // menu depth should not exceed the maximum supported depth
    $plugin_id = 'entity_hierarchy_microsite:' . $this->parent
      ->uuid();
    $this
      ->assertEquals($menu_max_depth, $menu_link_tree
      ->getSubtreeHeight($plugin_id));

    // microsite should still have descendants beyond the maximum supported depth
    $descendants = $this->treeStorage
      ->findDescendants($this->parentStub);
    $this
      ->assertEquals($entity_max_depth, end($descendants)
      ->getDepth());
  }

}

Members

Namesort descending Modifiers Type Description 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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
EntityHierarchyKernelTestBase::FIELD_NAME constant 1
EntityHierarchyMicrositeKernelTestBase::$modules protected static property Modules to enable. Overrides EntityHierarchyKernelTestBase::$modules
EntityHierarchyMicrositeKernelTestBase::doCreateTestEntity protected function Creates the test entity. Overrides EntityHierarchyTestTrait::doCreateTestEntity
EntityHierarchyMicrositeKernelTestBase::ENTITY_TYPE constant Overrides EntityHierarchyKernelTestBase::ENTITY_TYPE
EntityHierarchyMicrositeKernelTestBase::setUp protected function Overrides EntityHierarchyKernelTestBase::setUp
EntityHierarchyMicrositeKernelTestBase::setupEntityHierarchyField protected function Creates a new entity hierarchy field for the given bundle. Overrides EntityHierarchyTestTrait::setupEntityHierarchyField
EntityHierarchyTestTrait::$nodeFactory protected property Node key factory.
EntityHierarchyTestTrait::$parent protected property Test parent.
EntityHierarchyTestTrait::$parentStub protected property Node key for parent.
EntityHierarchyTestTrait::$treeStorage protected property Tree storage.
EntityHierarchyTestTrait::additionalSetup protected function Perform additional setup. 2
EntityHierarchyTestTrait::createChildEntities protected function Create child entities.
EntityHierarchyTestTrait::createTestEntity protected function Creates a new test entity. 4
EntityHierarchyTestTrait::doCreateChildTestEntity protected function Creates a new test entity. 2
EntityHierarchyTestTrait::getEntityFormDisplay protected function Gets entity form display.
EntityHierarchyTestTrait::setupEntityFormDisplay protected function Sets up entity form display.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 3
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::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
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 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
MediaTrait::createFile protected function Creates a file entity.
MediaTrait::createImageMedia protected function Create an image media entity.
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
MicrositeMenuItemsTest::testMicrositeMenuLinkDerivation public function Tests the microsite menu link integration.
MicrositeMenuItemsTest::testMicrositeMenuLinkMaxDepth public function Tests microsite menus do not exceed the maximum depth.
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::$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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser