You are here

abstract class FormatterTestBase in Range 8

Base class for range functional integration tests.

Hierarchy

Expanded class hierarchy of FormatterTestBase

File

tests/src/Kernel/Formatter/FormatterTestBase.php, line 12

Namespace

Drupal\Tests\range\Kernel\Formatter
View source
abstract class FormatterTestBase extends KernelTestBase {
  use RangeTestTrait;

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

  /**
   * Field type to test against.
   *
   * @var string
   */
  protected $fieldType;

  /**
   * Field name to test against.
   *
   * @var string
   */
  protected $fieldName;

  /**
   * Display type to test.
   *
   * @var string
   */
  protected $displayType;

  /**
   * Display type settings.
   *
   * @var array
   */
  protected $defaultSettings;

  /**
   * Entity, used for testing.
   *
   * @var \Drupal\entity_test\Entity\EntityTest
   */
  protected $entity;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installConfig([
      'system',
    ]);
    $this
      ->installConfig([
      'field',
    ]);
    $this
      ->installConfig([
      'text',
    ]);
    $this
      ->installConfig([
      'range',
    ]);
    $this
      ->installEntitySchema('entity_test');
    $this->fieldName = $this
      ->getFieldName($this->fieldType);
    $this
      ->createField($this->fieldType);
    $this
      ->createViewDisplay();
    $this->entity = EntityTest::create([]);
  }

  /**
   * Tests formatter.
   */
  public function testFieldFormatter() {

    // PHPUnit @dataProvider is calling setUp()/tearDown() with each data set
    // causing tests to be up to 20x slower.
    foreach ($this
      ->formatterDataProvider() as list($display_settings, $from, $to, $expected)) {
      $this
        ->assertFieldFormatter($display_settings, $from, $to, $expected);
    }
  }

  /**
   * Asserts that field formatter does its job.
   */
  protected function assertFieldFormatter(array $display_settings, $from, $to, $expected) {
    $this->entity->{$this->fieldName} = [
      'from' => $from,
      'to' => $to,
    ];
    $content = $this->entity->{$this->fieldName}
      ->get(0)
      ->view([
      'type' => $this->displayType,
      'settings' => $display_settings,
    ]);
    $renderer = $this->container
      ->get('renderer');
    $this
      ->assertEquals($expected, $renderer
      ->renderRoot($content));
  }

  /**
   * Formatter settings data provider.
   *
   * @return array
   *   Nested arrays of values to check:
   *     - $display_settings
   *     - $from
   *     - $to
   *     - $expected
   */
  protected function formatterDataProvider() {

    // Loop over the specific formatter settings.
    foreach ($this
      ->fieldFormatterDataProvider() as list($settings, $from, $to, $expected_from, $expected_to)) {

      // Loop over the base formatter settings.
      foreach ($this
        ->fieldFormatterBaseDataProvider() as list($base_settings, $expected_format_separate, $expected_format_combined)) {
        $diplay_settings = $settings + $base_settings + $this->defaultSettings;
        $expected_format = $expected_from !== $expected_to ? $expected_format_separate : $expected_format_combined;
        (yield [
          $diplay_settings,
          $from,
          $to,
          sprintf($expected_format, $expected_from, $expected_to),
        ]);
      }
    }
  }

  /**
   * Base formatter settings data provider.
   *
   * @return array
   *   Nested arrays of values to check:
   *     - $base_settings
   *     - $expected_format_separate
   *     - $expected_format_combined
   */
  protected function fieldFormatterBaseDataProvider() {
    (yield [
      [],
      '%s-%s',
      '%s',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
      ],
      '%s-%s',
      '%s-%s',
    ]);
    (yield [
      [
        'range_separator' => '|',
      ],
      '%s|%s',
      '%s',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'range_separator' => '=',
      ],
      '%s=%s',
      '%s=%s',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-%sfield_suffix',
      'field_prefix%sfield_suffix',
    ]);
    (yield [
      [
        'from_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-%s',
      'from_prefix%sfrom_suffix',
    ]);
    (yield [
      [
        'to_prefix_suffix' => TRUE,
      ],
      '%s-to_prefix%sto_suffix',
      'to_prefix%sto_suffix',
    ]);
    (yield [
      [
        'combined_prefix_suffix' => TRUE,
      ],
      '%s-%s',
      'combined_prefix%scombined_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'combined_prefix_suffix' => TRUE,
      ],
      '%s-%s',
      '%s-%s',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-%sfield_suffix',
      'field_prefixfrom_prefix%sfrom_suffixfield_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-to_prefix%sto_suffixfield_suffix',
      'field_prefixto_prefix%sto_suffixfield_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-%sfield_suffix',
      'field_prefixcombined_prefix%scombined_suffixfield_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'field_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-%sfield_suffix',
      'field_prefix%s-%sfield_suffix',
    ]);
    (yield [
      [
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-to_prefix%sto_suffix',
      'from_prefix%sto_suffix',
    ]);
    (yield [
      [
        'from_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-%s',
      'combined_prefix%scombined_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'from_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-%s',
      'from_prefix%sfrom_suffix-%s',
    ]);
    (yield [
      [
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      '%s-to_prefix%sto_suffix',
      'combined_prefix%scombined_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      '%s-to_prefix%sto_suffix',
      '%s-to_prefix%sto_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-to_prefix%sto_suffixfield_suffix',
      'field_prefixfrom_prefix%sto_suffixfield_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-%sfield_suffix',
      'field_prefixcombined_prefix%scombined_suffixfield_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-%sfield_suffix',
      'field_prefixfrom_prefix%sfrom_suffix-%sfield_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-to_prefix%sto_suffixfield_suffix',
      'field_prefixcombined_prefix%scombined_suffixfield_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'field_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefix%s-to_prefix%sto_suffixfield_suffix',
      'field_prefix%s-to_prefix%sto_suffixfield_suffix',
    ]);
    (yield [
      [
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-to_prefix%sto_suffix',
      'combined_prefix%scombined_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'from_prefix%sfrom_suffix-to_prefix%sto_suffix',
      'from_prefix%sfrom_suffix-to_prefix%sto_suffix',
    ]);
    (yield [
      [
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-to_prefix%sto_suffixfield_suffix',
      'field_prefixcombined_prefix%scombined_suffixfield_suffix',
    ]);
    (yield [
      [
        'range_combine' => FALSE,
        'field_prefix_suffix' => TRUE,
        'from_prefix_suffix' => TRUE,
        'to_prefix_suffix' => TRUE,
        'combined_prefix_suffix' => TRUE,
      ],
      'field_prefixfrom_prefix%sfrom_suffix-to_prefix%sto_suffixfield_suffix',
      'field_prefixfrom_prefix%sfrom_suffix-to_prefix%sto_suffixfield_suffix',
    ]);
  }

  /**
   * Specific formatter settings data provider.
   *
   * @return array
   *   Nested arrays of values to check:
   *     - $settings
   *     - $from
   *     - $to
   *     - $expected_from
   *     - $expected_to
   */
  protected abstract function fieldFormatterDataProvider();

}

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.
FormatterTestBase::$defaultSettings protected property Display type settings.
FormatterTestBase::$displayType protected property Display type to test.
FormatterTestBase::$entity protected property Entity, used for testing.
FormatterTestBase::$fieldName protected property Field name to test against.
FormatterTestBase::$fieldType protected property Field type to test against.
FormatterTestBase::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
FormatterTestBase::assertFieldFormatter protected function Asserts that field formatter does its job.
FormatterTestBase::fieldFormatterBaseDataProvider protected function Base formatter settings data provider.
FormatterTestBase::fieldFormatterDataProvider abstract protected function Specific formatter settings data provider. 5
FormatterTestBase::formatterDataProvider protected function Formatter settings data provider.
FormatterTestBase::setUp protected function Overrides KernelTestBase::setUp 5
FormatterTestBase::testFieldFormatter public function Tests formatter.
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.
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.
RangeTestTrait::$bundle protected property Bundle to test against.
RangeTestTrait::$entityType protected property Entity type ID to test against.
RangeTestTrait::$field protected property Field used for tests.
RangeTestTrait::$fieldStorage protected property Field storage used for tests.
RangeTestTrait::$formDisplay protected property Form display to test.
RangeTestTrait::$viewDisplay protected property View display to test.
RangeTestTrait::createField protected function Creates a range field of a given type.
RangeTestTrait::createFormDisplay protected function Creates default form display.
RangeTestTrait::createViewDisplay protected function Creates default view display.
RangeTestTrait::deleteField protected function Deletes previously created range field.
RangeTestTrait::getFieldName protected function Returns field name (with "field_" prefix added by Drupal field UI).
RangeTestTrait::getFieldNameRaw protected function Returns raw field name (without "field_" prefix added by Drupal field UI).
RangeTestTrait::getFieldSettings protected function Returns test range field settings.
RangeTestTrait::getFieldStorageSettings protected function Returns test range field storage settings.
RangeTestTrait::getRangeFieldTypes protected function Returns list of available range field types.
RangeTestTrait::getWidgetSettings protected function Returns test range widget settings.
RangeTestTrait::setFormDisplayComponent protected function Sets the display settings for a default form display.
RangeTestTrait::setViewDisplayComponent protected function Sets the display settings for a default view display.
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.