You are here

Home » API reference » Entity Reference Hierarchy 3.x » BreadcrumbTest.php

class BreadcrumbTest in Entity Reference Hierarchy 3.x

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

Tests for breadcrumbs built of entity hierarchy fields.

@group entity_hierarchy_breadcrumb

Hierarchy

Expanded class hierarchy of BreadcrumbTest

File

modules/entity_hierarchy_breadcrumb/tests/src/Kernel/BreadcrumbTest.php, line 15

Namespace

Drupal\Tests\entity_hierarchy_breadcrumb\Kernel
View source 
class BreadcrumbTest extends EntityHierarchyKernelTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'entity_hierarchy_breadcrumb',
    'entity_hierarchy',
    'entity_test',
    'system',
    'user',
    'dbal',
    'field',
  ];

  /**
   * A route to test with.
   *
   * @var \Symfony\Component\Routing\Route
   */
  protected $testRoute;

  /**
   * The breadcrumb manager service.
   *
   * @var \Drupal\Core\Breadcrumb\BreadcrumbBuilderInterface
   */
  protected $breadcrumbBuilder;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();
    $user = $this
      ->createUser([], [
      'view test entity',
    ]);
    $this->container
      ->get('account_switcher')
      ->switchTo($user);
    $this->breadcrumbBuilder = $this->container
      ->get('entity_hierarchy.breadcrumb');
    $this->testRoute = new Route('/entity_test/{entity_test}', [], [], [
      'parameters' => [
        static::ENTITY_TYPE => [
          'type' => 'entity:' . static::ENTITY_TYPE,
        ],
      ],
    ]);
  }

  /**
   * Tests the applies when the entity has a hierarchy field.
   */
  public function testAppliesWhenOnEntityWithParentField() {
    $route_match = new RouteMatch('test', $this->testRoute, [
      static::ENTITY_TYPE => $this->parent,
    ], [
      static::ENTITY_TYPE => $this->parent,
    ]);
    $this
      ->assertTrue($this->breadcrumbBuilder
      ->applies($route_match));
  }

  /**
   * Tests applies on bundle without hierarchy field.
   */
  public function testAppliesOnEntityTypeWithoutParentField() {
    $bundle = EntityTestBundle::create([
      'id' => 'a_different_bundle',
    ]);
    $bundle
      ->save();
    $entity = $this
      ->doCreateTestEntity([
      'type' => $bundle
        ->id(),
    ]);
    $route_match = new RouteMatch('test', $this->testRoute, [
      static::ENTITY_TYPE => $entity,
    ], [
      static::ENTITY_TYPE => $entity,
    ]);
    $this
      ->assertFalse($this->breadcrumbBuilder
      ->applies($route_match));
  }

  /**
   * Tests applies on admin route.
   */
  public function testAppliesOnAdminRoute() {
    $this->testRoute
      ->setOption('_admin_route', TRUE);
    $route_match = new RouteMatch('test', $this->testRoute, [
      static::ENTITY_TYPE => $this->parent,
    ], [
      static::ENTITY_TYPE => $this->parent,
    ]);
    $this
      ->assertFalse($this->breadcrumbBuilder
      ->applies($route_match));
  }

  /**
   * Tests applies on non entity route.
   */
  public function testAppliesWithNoEntityInRouteMatch() {
    $route_match = new RouteMatch('test', $this->testRoute);
    $this
      ->assertFalse($this->breadcrumbBuilder
      ->applies($route_match));
  }

  /**
   * Tests breadcrumb builder returns the hierarchy.
   */
  public function testBreadcrumbsFollowHierarchy() {
    $entity_type = static::ENTITY_TYPE;
    $children = $this
      ->createChildEntities($this->parent
      ->id(), 3);
    $child = reset($children);
    $grandchildren = $this
      ->createChildEntities($child
      ->id(), 3);
    $grandchild = reset($grandchildren);
    $route_match = new RouteMatch('test', $this->testRoute, [
      $entity_type => $grandchild,
    ], [
      $entity_type => $grandchild
        ->id(),
    ]);
    $actual = $this->breadcrumbBuilder
      ->build($route_match);
    $this
      ->assertNotEquals(0, $actual
      ->getCacheMaxAge());
    $actual_links = $actual
      ->getLinks();
    $expected_cache_tags = [
      sprintf("%s:%s", $entity_type, $this->parent
        ->id()),
      sprintf("%s:%s", $entity_type, $child
        ->id()),
      sprintf("%s:%s", $entity_type, $grandchild
        ->id()),
    ];
    $this
      ->assertEquals($expected_cache_tags, $actual
      ->getCacheTags());
    $this
      ->assertEquals('Home', $actual_links[0]
      ->getText());
    $this
      ->assertEquals('/', $actual_links[0]
      ->getUrl()
      ->toString());
    $this
      ->assertEquals($this->parent
      ->label(), $actual_links[1]
      ->getText());
    $this
      ->assertEquals($this->parent
      ->toUrl()
      ->toString(), $actual_links[1]
      ->getUrl()
      ->toString());
    $this
      ->assertEquals($child
      ->label(), $actual_links[2]
      ->getText());
    $this
      ->assertEquals($child
      ->toUrl()
      ->toString(), $actual_links[2]
      ->getUrl()
      ->toString());
    $this
      ->assertEquals($grandchild
      ->label(), $actual_links[3]
      ->getText());
    $this
      ->assertEquals('', $actual_links[3]
      ->getUrl()
      ->toString());
  }

}

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
BreadcrumbTest::$breadcrumbBuilder protected property The breadcrumb manager service.
BreadcrumbTest::$modules protected static property Modules to enable. Overrides EntityHierarchyKernelTestBase::$modules
BreadcrumbTest::$testRoute protected property A route to test with.
BreadcrumbTest::setUp public function Overrides EntityHierarchyKernelTestBase::setUp
BreadcrumbTest::testAppliesOnAdminRoute public function Tests applies on admin route.
BreadcrumbTest::testAppliesOnEntityTypeWithoutParentField public function Tests applies on bundle without hierarchy field.
BreadcrumbTest::testAppliesWhenOnEntityWithParentField public function Tests the applies when the entity has a hierarchy field.
BreadcrumbTest::testAppliesWithNoEntityInRouteMatch public function Tests applies on non entity route.
BreadcrumbTest::testBreadcrumbsFollowHierarchy public function Tests breadcrumb builder returns the hierarchy.
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.
EntityHierarchyKernelTestBase::ENTITY_TYPE constant 4
EntityHierarchyKernelTestBase::FIELD_NAME constant 1
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::doCreateTestEntity protected function Creates the test entity. 8
EntityHierarchyTestTrait::getEntityFormDisplay protected function Gets entity form display.
EntityHierarchyTestTrait::setupEntityFormDisplay protected function Sets up entity form display.
EntityHierarchyTestTrait::setupEntityHierarchyField protected function Creates a new entity hierarchy field for the given bundle. 2
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.
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.
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