You are here

Home » API reference » Extra Field 8.2 » ExtraFieldDisplayPluginTest.php

class ExtraFieldDisplayPluginTest in Extra Field 8.2

Kernel test for Extra Field display plugins.

@group extra_field

Hierarchy

Expanded class hierarchy of ExtraFieldDisplayPluginTest

File

tests/src/Kernel/ExtraFieldDisplayPluginTest.php, line 17

Namespace

Drupal\Tests\extra_field\Kernel
View source 
class ExtraFieldDisplayPluginTest extends KernelTestBase {
  use NodeCreationTrait;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'extra_field',
    'extra_field_test',
    'node',
    'field',
    'user',
    'system',
  ];

  /**
   * The plugin manager under test.
   *
   * @var \Drupal\extra_field\Plugin\ExtraFieldDisplayManager
   */
  protected $displayManager;

  /**
   * The node that contains the extra fields under test.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $node;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this->container
      ->get('entity_type.manager')
      ->getStorage('node_type')
      ->create([
      'name' => 'Test',
      'title_label' => 'Title',
      'type' => 'test',
      'create_body' => FALSE,
    ])
      ->save();
    $this->node = $this->container
      ->get('entity_type.manager')
      ->getStorage('node')
      ->create([
      'type' => 'test',
      'title' => $this
        ->randomString(),
    ]);
  }

  /**
   * Tests display basic plugins.
   *
   * @param string $pluginId
   *   Plugin ID of the plugin under test.
   * @param array $output
   *   Plugin output as returned by ::view.
   *
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayBase::view
   *
   * @dataProvider displayPluginProvider
   */
  public function testDisplayPlugin($pluginId, array $output) {
    switch ($pluginId) {
      case 'all_node_types_test':
        $extraField = new AllNodeTypesTest([], $pluginId, []);
        break;
    }
    $pluginOutput = $extraField
      ->view($this->node);
    unset($pluginOutput['#object']);
    unset($pluginOutput['#items']);
    $this
      ->assertEquals($output, $pluginOutput);
  }

  /**
   * Data provider for basic display plugins.
   *
   * @return array
   *   Contains:
   *   - Plugin ID.
   *   - Plugin output as returned by ::view.
   */
  public function displayPluginProvider() {
    $info[] = [
      'all_node_types_test',
      [
        '#markup' => 'Output from AllNodeTypesTest',
      ],
    ];
    return $info;
  }

  /**
   * Tests formatted display plugins.
   *
   * @param string $pluginId
   *   Plugin ID of the plugin under test.
   * @param array $output
   *   Plugin output as returned by ::view.
   * @param array $methods
   *   Return value of various plugin methods.
   *
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::view
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::getLabel
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::getLabelDisplay
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::getFieldName
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::getFieldType
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::isEmpty
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::getLangcode
   * @covers \Drupal\extra_field\Plugin\ExtraFieldDisplayFormattedBase::isTranslatable
   *
   * @dataProvider displayPluginFormattedProvider
   */
  public function testDisplayFormattedPlugin($pluginId, array $output, array $methods) {
    switch ($pluginId) {
      case 'single_text_test':
        $extraField = new SingleTextFieldTest([], $pluginId, []);
        break;
      case 'empty_formatted_test':
        $extraField = new EmptyFormattedFieldTest([], $pluginId, []);
        break;
      case 'multiple_text_test':
        $extraField = new MultipleItemsFieldTest([], $pluginId, []);
        break;
    }
    $pluginOutput = $extraField
      ->view($this->node);
    unset($pluginOutput['#object']);
    unset($pluginOutput['#items']);
    $pluginMethod = [
      'getLabel' => $extraField
        ->getLabel(),
      'getLabelDisplay' => $extraField
        ->getLabelDisplay(),
      'getFieldName' => $extraField
        ->getFieldName(),
      'getFieldType' => $extraField
        ->getFieldType(),
      'isEmpty' => $extraField
        ->isEmpty(),
      'getLangcode' => $extraField
        ->getLangcode(),
      'isTranslatable' => $extraField
        ->isTranslatable(),
    ];
    $this
      ->assertEquals($output, $pluginOutput);
    $this
      ->assertEquals($methods, $pluginMethod);
  }

  /**
   * Data provider for formatted display plugins.
   *
   * @return array
   *   Contains:
   *   - Plugin ID.
   *   - Plugin output as returned by ::view.
   *   - Return value of various plugin methods. Keyed by their method name.
   */
  public function displayPluginFormattedProvider() {
    $info[] = [
      'single_text_test',
      [
        '#theme' => 'field',
        '#title' => 'Single text',
        '#label_display' => 'inline',
        '#view_mode' => '_custom',
        '#language' => 'und',
        '#field_name' => 'field_single_text',
        '#field_type' => 'single_text',
        '#field_translatable' => FALSE,
        '#entity_type' => 'node',
        '#bundle' => 'test',
        '#formatter' => 'single_text_test',
        '#is_multiple' => FALSE,
        '0' => [
          '#markup' => 'Output from SingleTextFieldTest',
        ],
      ],
      [
        'getLabel' => 'Single text',
        'getLabelDisplay' => 'inline',
        'getFieldName' => 'field_single_text',
        'getFieldType' => 'single_text',
        'isEmpty' => FALSE,
        'getLangcode' => 'und',
        'isTranslatable' => FALSE,
      ],
    ];
    $info[] = [
      'empty_formatted_test',
      [
        '#cache' => [
          'max-age' => 0,
        ],
      ],
      [
        'getLabel' => 'Empty field',
        'getLabelDisplay' => 'inline',
        'getFieldName' => 'extra_field_empty_formatted_test',
        'getFieldType' => 'extra_field',
        'isEmpty' => TRUE,
        'getLangcode' => 'und',
        'isTranslatable' => FALSE,
      ],
    ];
    $info[] = [
      'multiple_text_test',
      [
        '#theme' => 'field',
        '#title' => '',
        '#label_display' => 'hidden',
        '#view_mode' => '_custom',
        '#language' => 'und',
        '#field_name' => 'extra_field_multiple_text_test',
        '#field_type' => 'extra_field',
        '#field_translatable' => FALSE,
        '#entity_type' => 'node',
        '#bundle' => 'test',
        '#formatter' => 'multiple_text_test',
        '#is_multiple' => TRUE,
        '#cache' => [],
        '#children' => '',
        '0' => [
          '#markup' => 'Aap',
        ],
        '1' => [
          '#markup' => 'Noot',
        ],
        '2' => [
          '#markup' => 'Mies',
        ],
        '3' => [
          '#markup' => 'Wim',
        ],
        '4' => [
          '#markup' => 'Zus',
        ],
        '5' => [
          '#markup' => 'Jet',
        ],
      ],
      [
        'getLabel' => '',
        'getLabelDisplay' => 'hidden',
        'getFieldName' => 'extra_field_multiple_text_test',
        'getFieldType' => 'extra_field',
        'isEmpty' => FALSE,
        'getLangcode' => 'und',
        'isTranslatable' => FALSE,
      ],
    ];
    return $info;
  }

}

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.
ExtraFieldDisplayPluginTest::$displayManager protected property The plugin manager under test.
ExtraFieldDisplayPluginTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ExtraFieldDisplayPluginTest::$node protected property The node that contains the extra fields under test.
ExtraFieldDisplayPluginTest::displayPluginFormattedProvider public function Data provider for formatted display plugins.
ExtraFieldDisplayPluginTest::displayPluginProvider public function Data provider for basic display plugins.
ExtraFieldDisplayPluginTest::setUp protected function Overrides KernelTestBase::setUp
ExtraFieldDisplayPluginTest::testDisplayFormattedPlugin public function Tests formatted display plugins.
ExtraFieldDisplayPluginTest::testDisplayPlugin public function Tests display basic plugins.
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 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.
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.