abstract class FormatterTestBase in Range 8
Base class for range functional integration tests.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses AssertContentTrait, AssertLegacyTrait, AssertHelperTrait, ConfigTestTrait, PhpunitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait
- class \Drupal\Tests\range\Kernel\Formatter\FormatterTestBase uses RangeTestTrait
Expanded class hierarchy of FormatterTestBase
File
- tests/
src/ Kernel/ Formatter/ FormatterTestBase.php, line 12
Namespace
Drupal\Tests\range\Kernel\FormatterView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertHelperTrait:: |
protected static | function | Casts MarkupInterface objects into strings. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead. | |
AssertLegacyTrait:: |
protected | function | Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead. | |
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
FormatterTestBase:: |
protected | property | Display type settings. | |
FormatterTestBase:: |
protected | property | Display type to test. | |
FormatterTestBase:: |
protected | property | Entity, used for testing. | |
FormatterTestBase:: |
protected | property | Field name to test against. | |
FormatterTestBase:: |
protected | property | Field type to test against. | |
FormatterTestBase:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
FormatterTestBase:: |
protected | function | Asserts that field formatter does its job. | |
FormatterTestBase:: |
protected | function | Base formatter settings data provider. | |
FormatterTestBase:: |
abstract protected | function | Specific formatter settings data provider. | 5 |
FormatterTestBase:: |
protected | function | Formatter settings data provider. | |
FormatterTestBase:: |
protected | function |
Overrides KernelTestBase:: |
5 |
FormatterTestBase:: |
public | function | Tests formatter. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 1 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | Returns whether the current test method is running in a separate process. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
26 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 6 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | BC: Automatically resolve former KernelTestBase class properties. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpunitCompatibilityTrait:: |
public | function | Returns a mock object for the specified class using the available method. | |
PhpunitCompatibilityTrait:: |
public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RangeTestTrait:: |
protected | property | Bundle to test against. | |
RangeTestTrait:: |
protected | property | Entity type ID to test against. | |
RangeTestTrait:: |
protected | property | Field used for tests. | |
RangeTestTrait:: |
protected | property | Field storage used for tests. | |
RangeTestTrait:: |
protected | property | Form display to test. | |
RangeTestTrait:: |
protected | property | View display to test. | |
RangeTestTrait:: |
protected | function | Creates a range field of a given type. | |
RangeTestTrait:: |
protected | function | Creates default form display. | |
RangeTestTrait:: |
protected | function | Creates default view display. | |
RangeTestTrait:: |
protected | function | Deletes previously created range field. | |
RangeTestTrait:: |
protected | function | Returns field name (with "field_" prefix added by Drupal field UI). | |
RangeTestTrait:: |
protected | function | Returns raw field name (without "field_" prefix added by Drupal field UI). | |
RangeTestTrait:: |
protected | function | Returns test range field settings. | |
RangeTestTrait:: |
protected | function | Returns test range field storage settings. | |
RangeTestTrait:: |
protected | function | Returns list of available range field types. | |
RangeTestTrait:: |
protected | function | Returns test range widget settings. | |
RangeTestTrait:: |
protected | function | Sets the display settings for a default form display. | |
RangeTestTrait:: |
protected | function | Sets the display settings for a default view display. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |