You are here

Home » API reference » Menu Link (Field) 8 » MenuLinkFormatterTest.php

class MenuLinkFormatterTest in Menu Link (Field) 8

Tests the menu link field formatters.

@group menu_link

Hierarchy

Expanded class hierarchy of MenuLinkFormatterTest

File

tests/src/Kernel/MenuLinkFormatterTest.php, line 25

Namespace

Drupal\Tests\menu_link\Kernel
View source 
class MenuLinkFormatterTest extends KernelTestBase {

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Allow tests to compare MarkupInterface objects via assertEquals().
    $this
      ->registerComparator(new MarkupInterfaceComparator());
    $this->root = static::getDrupalRoot();
    $this
      ->initFileCache();
    $this
      ->bootEnvironment();
    $this
      ->bootKernel();
  }

  /**
   * Installs database tables from a module schema definition.
   *
   * @param string $module
   *   The name of the module that defines the table's schema.
   * @param string|array $tables
   *   The name or an array of the names of the tables to install.
   *
   * @throws \LogicException
   *   If $module is not enabled or the table schema cannot be found.
   */
  protected function installSchema($module, $tables) : void {
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('entity_test_mul');
    FieldStorageConfig::create([
      'field_name' => 'field_menu_link',
      'entity_type' => 'entity_test_mul',
      'type' => 'menu_link',
    ])
      ->save();
    FieldConfig::create([
      'field_name' => 'field_menu_link',
      'entity_type' => 'entity_test_mul',
      'bundle' => 'entity_test_mul',
    ])
      ->save();
  }

  /**
   * Tests the menu_link and menu_link_breadcrumb field formatters.
   */
  public function testMenuLinkFormatters() : void {
    $entity_test_mul = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link' => [
        'menu_name' => 'test_menu',
        'title' => 'test title 1',
        'description' => 'test description',
      ],
    ]);

    /** @var \Drupal\Core\Menu\MenuLinkTree $menu_tree */
    $menu_tree = \Drupal::service('menu.link_tree');
    $parameters = new MenuTreeParameters();
    $parameters
      ->addCondition('title', 'test title 1');
    $entity_test_mul
      ->save();
    $result = $menu_tree
      ->load('test_menu', $parameters);
    $menu_link = reset($result);

    // Add another entity as a child of the first one.
    $entity_test_mul2 = EntityTestMul::create([
      'type' => 'entity_test_mul',
      'name' => 'test',
      'field_menu_link' => [
        'menu_name' => 'test_menu',
        'parent' => $menu_link->link
          ->getPluginId(),
        'title' => 'test title 2',
        'description' => 'test description 2',
      ],
    ]);
    $entity_test_mul2
      ->save();

    // Test that the menu_link formatter outputs plain text.
    $content = $this
      ->renderLink($entity_test_mul2, 'menu_link', [
      'link_to_target' => FALSE,
    ]);
    $this
      ->assertRaw('<div>test title 2</div>', $content);

    // Test that the menu_link formatter outputs a link.
    $content2 = $this
      ->renderLink($entity_test_mul2, 'menu_link', [
      'link_to_target' => TRUE,
    ]);
    $this
      ->assertRaw('<div><a href="/entity_test_mul/manage/2" title="test description 2" hreflang="en">test title 2</a></div>', $content2);

    // Test that the breadcrumb formatter outputs links.
    $content3 = $this
      ->renderLink($entity_test_mul2, 'menu_link_breadcrumb', [
      'link_to_target' => TRUE,
    ]);
    $this
      ->assertRaw('<a href="/entity_test_mul/manage/1">test title 1</a>', $content3);
    $this
      ->assertRaw('<a href="/entity_test_mul/manage/2">test title 2</a>', $content3);

    // Test that the breadcrumb formatter outputs plain text.
    $content4 = $this
      ->renderLink($entity_test_mul2, 'menu_link_breadcrumb', [
      'link_to_target' => FALSE,
    ]);
    $this
      ->assertRaw('test title 1', $content4);
    $this
      ->assertRaw('test title 2', $content4);
    $this
      ->assertNoRaw('<a href="/entity_test_mul/manage/1">test title 1</a>', $content3);
    $this
      ->assertNoRaw('<a href="/entity_test_mul/manage/2">test title 2</a>', $content3);

    // Test that we skip the last element when parents_only is enabled.
    $content5 = $this
      ->renderLink($entity_test_mul2, 'menu_link_breadcrumb', [
      'link_to_target' => FALSE,
      'parents_only' => TRUE,
    ]);
    $this
      ->assertRaw('test title 1', $content5);
    $this
      ->assertNoRaw('test title 2', $content5);
  }

  /**
   * Renders a menu link field.
   *
   * @param $entity
   *   The entity to render the link for.
   * @param string|array $type
   *   The ID of the field formatter.
   * @param string|array $settings
   *   The field formatter settings.
   *
   * @return string
   *   The rendered output.
   */
  protected function renderLink($entity, $type, $settings) : string {
    $display = \Drupal::service('entity_display.repository')
      ->getViewDisplay('entity_test_mul', 'entity_test_mul', 'default')
      ->setComponent('field_menu_link', [
      'type' => $type,
      'settings' => $settings,
    ]);
    $content = $display
      ->build($entity);
    return $this
      ->render($content);
  }

  /**
   * Returns the modules to enable for this test.
   *
   * @param string $class
   *   The fully-qualified class name of this test.
   *
   * @return array
   */
  private static function getModulesToEnable(string $class) : array {
    $modules = [];
    while ($class) {
      if (property_exists($class, 'modules')) {

        // Only add the modules, if the $modules property was not inherited.
        $rp = new \ReflectionProperty($class, 'modules');
        if ($rp->class === $class) {
          $modules[$class] = $class::$modules;
        }
      }
      $class = get_parent_class($class);
    }

    // Modules have been collected in reverse class hierarchy order; modules
    // defined by base classes should be sorted first. Then, merge the results
    // together.
    $modules = array_reverse($modules);
    return call_user_func_array('array_merge_recursive', $modules);
  }

  /**
   * Returns Extension objects for $modules to enable.
   *
   * @param string[] $modules
   *   The list of modules to enable.
   *
   * @return \Drupal\Core\Extension\Extension[]
   *   Extension objects for $modules, keyed by module name.
   *
   * @throws \PHPUnit\Framework\Exception
   *   If a module is not available.
   *
   * @see \Drupal\Tests\KernelTestBase::enableModules()
   * @see \Drupal\Core\Extension\ModuleHandler::add()
   */
  private function getExtensionsForModules(array $modules) : array {
    $extensions = [];
    $discovery = new ExtensionDiscovery($this->root);
    $discovery
      ->setProfileDirectories([]);
    $list = $discovery
      ->scan('module');
    foreach ($modules as $name) {
      if (!isset($list[$name])) {
        throw new Exception("Unavailable module: '{$name}'. If this module needs to be downloaded separately, annotate the test class with '@requires module {$name}'.");
      }
      $extensions[$name] = $list[$name];
    }
    return $extensions;
  }

  /**
   * Bootstraps a kernel for a test.
   */
  private function bootKernel() : void {
    $this
      ->setSetting('container_yamls', []);

    // Allow for test-specific overrides.
    $settings_services_file = $this->root . '/sites/default/testing.services.yml';
    if (file_exists($settings_services_file)) {

      // Copy the testing-specific service overrides in place.
      $testing_services_file = $this->siteDirectory . '/services.yml';
      copy($settings_services_file, $testing_services_file);
      $this
        ->setSetting('container_yamls', [
        $testing_services_file,
      ]);
    }

    // Allow for global test environment overrides.
    if (file_exists($test_env = $this->root . '/sites/default/testing.services.yml')) {
      $GLOBALS['conf']['container_yamls']['testing'] = $test_env;
    }

    // Add this test class as a service provider.
    $GLOBALS['conf']['container_service_providers']['test'] = $this;
    $modules = self::getModulesToEnable(get_class($this));

    // Bootstrap the kernel. Do not use createFromRequest() to retain Settings.
    $kernel = new DrupalKernel('testing', $this->classLoader, FALSE);
    $kernel
      ->setSitePath($this->siteDirectory);

    // Boot a new one-time container from scratch. Set the module list upfront
    // to avoid a subsequent rebuild or setting the kernel into the
    // pre-installer mode.
    $extensions = $modules ? $this
      ->getExtensionsForModules($modules) : [];
    $kernel
      ->updateModules($extensions, $extensions);

    // DrupalKernel::boot() is not sufficient as it does not invoke preHandle(),
    // which is required to initialize legacy global variables.
    $request = Request::create('/');
    $kernel
      ->boot();
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_OBJECT, new Route('<none>'));
    $request->attributes
      ->set(RouteObjectInterface::ROUTE_NAME, '<none>');
    $kernel
      ->preHandle($request);
    $this->container = $kernel
      ->getContainer();

    // Ensure database tasks have been run.
    require_once __DIR__ . '/../../../../../../core/includes/install.inc';
    $connection_info = Database::getConnectionInfo();
    $driver = $connection_info['default']['driver'];
    $namespace = $connection_info['default']['namespace'] ?? NULL;
    $errors = db_installer_object($driver, $namespace)
      ->runTasks();
    if (!empty($errors)) {
      self::fail('Failed to run installer database tasks: ' . implode(', ', $errors));
    }
    if ($modules) {
      $this->container
        ->get('module_handler')
        ->loadAll();
    }

    // Setup the destination to the be frontpage by default.
    \Drupal::destination()
      ->set('/');

    // Write the core.extension configuration.
    // Required for ConfigInstaller::installDefaultConfig() to work.
    $this->container
      ->get('config.storage')
      ->write('core.extension', [
      'module' => array_fill_keys($modules, 0),
      'theme' => [],
      'profile' => '',
    ]);
    $settings = Settings::getAll();
    $settings['php_storage']['default'] = [
      'class' => '\\Drupal\\Component\\PhpStorage\\FileStorage::class',
    ];
    new Settings($settings);

    // Manually configure the test mail collector implementation to prevent
    // tests from sending out emails and collect them in state instead.
    // While this should be enforced via settings.php prior to installation,
    // some tests expect to be able to test mail system implementations.
    $GLOBALS['config']['system.mail']['interface']['default'] = 'test_mail_collector';

    // Manually configure the default file scheme so that modules that use file
    // functions don't have to install system and its configuration.
    // @see file_default_scheme()
    $GLOBALS['config']['system.file']['default_scheme'] = 'public';
  }

}

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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
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.
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::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::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::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 6
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.
MenuLinkFormatterTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
MenuLinkFormatterTest::bootKernel private function Bootstraps a kernel for a test. Overrides KernelTestBase::bootKernel
MenuLinkFormatterTest::getExtensionsForModules private function Returns Extension objects for $modules to enable. Overrides KernelTestBase::getExtensionsForModules
MenuLinkFormatterTest::getModulesToEnable private static function Returns the modules to enable for this test. Overrides KernelTestBase::getModulesToEnable
MenuLinkFormatterTest::installSchema protected function Installs database tables from a module schema definition. Overrides KernelTestBase::installSchema
MenuLinkFormatterTest::renderLink protected function Renders a menu link field.
MenuLinkFormatterTest::setUp protected function Overrides KernelTestBase::setUp
MenuLinkFormatterTest::testMenuLinkFormatters public function Tests the menu_link and menu_link_breadcrumb field formatters.
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.