class FieldKernelTestBase

Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase
  2. 8.9.x core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase
  3. 10 core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase

Parent class for Field API unit tests.

Hierarchy

Expanded class hierarchy of FieldKernelTestBase

20 files declare their use of FieldKernelTestBase
BooleanItemTest.php in core/modules/field/tests/src/Kernel/Boolean/BooleanItemTest.php
CommentItemTest.php in core/modules/comment/tests/src/Kernel/CommentItemTest.php
DateRangeItemTest.php in core/modules/datetime_range/tests/src/Kernel/DateRangeItemTest.php
DateTimeItemTest.php in core/modules/datetime/tests/src/Kernel/DateTimeItemTest.php
EmailItemTest.php in core/modules/field/tests/src/Kernel/Email/EmailItemTest.php

... See full list

File

core/modules/field/tests/src/Kernel/FieldKernelTestBase.php, line 17

Namespace

Drupal\Tests\field\Kernel
View source
abstract class FieldKernelTestBase extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'user',
        'system',
        'field',
        'text',
        'entity_test',
        'field_test',
    ];
    
    /**
     * Bag of created field storages and fields.
     *
     * Allows easy access to test field storage/field names/IDs/objects via:
     * - $this->fieldTestData->field_name[suffix]
     * - $this->fieldTestData->field_storage[suffix]
     * - $this->fieldTestData->field_storage_uuid[suffix]
     * - $this->fieldTestData->field[suffix]
     * - $this->fieldTestData->field_definition[suffix]
     *
     * @var \ArrayObject
     *
     * @see \Drupal\field\Tests\FieldUnitTestBase::createFieldWithStorage()
     */
    protected $fieldTestData;
    
    /**
     * @var string
     */
    protected string $entityId;
    
    /**
     * Set the default field storage backend for fields created during tests.
     */
    protected function setUp() : void {
        parent::setUp();
        $this->fieldTestData = new \ArrayObject([], \ArrayObject::ARRAY_AS_PROPS);
        $this->installEntitySchema('entity_test');
        $this->installEntitySchema('user');
        // Set default storage backend and configure the theme system.
        $this->installConfig([
            'field',
            'system',
            'user',
        ]);
        // Create user 1.
        $storage = \Drupal::entityTypeManager()->getStorage('user');
        $storage->create([
            'uid' => 1,
            'name' => 'entity-test',
            'mail' => 'entity@localhost',
            'status' => TRUE,
        ])
            ->save();
    }
    
    /**
     * Create a field and an associated field storage.
     *
     * @param string $suffix
     *   (optional) A string that should only contain characters that are valid in
     *   PHP variable names as well.
     * @param string $entity_type
     *   (optional) The entity type on which the field should be created.
     *   Defaults to "entity_test".
     * @param string $bundle
     *   (optional) The entity type on which the field should be created.
     *   Defaults to the default bundle of the entity type.
     */
    protected function createFieldWithStorage($suffix = '', $entity_type = 'entity_test', $bundle = NULL) {
        if (empty($bundle)) {
            $bundle = $entity_type;
        }
        $field_name = 'field_name' . $suffix;
        $field_storage = 'field_storage' . $suffix;
        $field_storage_uuid = 'field_storage_uuid' . $suffix;
        $field = 'field' . $suffix;
        $field_definition = 'field_definition' . $suffix;
        $this->fieldTestData->{$field_name} = $this->randomMachineName() . '_field_name' . $suffix;
        $this->fieldTestData->{$field_storage} = FieldStorageConfig::create([
            'field_name' => $this->fieldTestData->{$field_name},
            'entity_type' => $entity_type,
            'type' => 'test_field',
            'cardinality' => 4,
        ]);
        $this->fieldTestData->{$field_storage}
            ->save();
        $this->fieldTestData->{$field_storage_uuid} = $this->fieldTestData->{$field_storage}
            ->uuid();
        $this->fieldTestData->{$field_definition} = [
            'field_storage' => $this->fieldTestData->{$field_storage},
            'bundle' => $bundle,
            'label' => $this->randomMachineName() . '_label',
            'description' => $this->randomMachineName() . '_description',
            'settings' => [
                'test_field_setting' => $this->randomMachineName(),
            ],
        ];
        $this->fieldTestData->{$field} = FieldConfig::create($this->fieldTestData->{$field_definition});
        $this->fieldTestData->{$field}
            ->save();
        \Drupal::service('entity_display.repository')->getFormDisplay($entity_type, $bundle)
            ->setComponent($this->fieldTestData->{$field_name}, [
            'type' => 'test_field_widget',
            'settings' => [
                'test_widget_setting' => $this->randomMachineName(),
            ],
        ])
            ->save();
    }
    
    /**
     * Saves and reloads an entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity to save.
     *
     * @return \Drupal\Core\Entity\EntityInterface
     *   The entity, freshly reloaded from storage.
     */
    protected function entitySaveReload(EntityInterface $entity) : EntityInterface {
        $entity->save();
        $controller = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity->getEntityTypeId());
        $controller->resetCache();
        return $controller->load($entity->id());
    }
    
    /**
     * Validate and save entity. Fail if violations are found.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity to save.
     */
    protected function entityValidateAndSave(EntityInterface $entity) {
        $violations = $entity->validate();
        if ($violations->count()) {
            $this->fail((string) $violations);
        }
        else {
            $entity->save();
        }
    }
    
    /**
     * Generate random values for a field_test field.
     *
     * @param int $cardinality
     *   Number of values to generate.
     *
     * @return array
     *   An array of random values, in the format expected for field values.
     */
    protected function _generateTestFieldValues($cardinality) {
        $values = [];
        for ($i = 0; $i < $cardinality; $i++) {
            // field_test fields treat 0 as 'empty value'.
            $values[$i]['value'] = mt_rand(1, 127);
        }
        return $values;
    }
    
    /**
     * Assert that a field has the expected values in an entity.
     *
     * This function only checks a single column in the field values.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity to test.
     * @param string $field_name
     *   The name of the field to test
     * @param array $expected_values
     *   The array of expected values.
     * @param string $langcode
     *   (Optional) The language code for the values. Defaults to
     *   \Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED.
     * @param string $column
     *   (Optional) The name of the column to check. Defaults to 'value'.
     */
    protected function assertFieldValues(EntityInterface $entity, $field_name, $expected_values, $langcode = LanguageInterface::LANGCODE_NOT_SPECIFIED, $column = 'value') {
        $expected_values_count = count($expected_values);
        // Re-load the entity to make sure we have the latest changes.
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity->getEntityTypeId());
        $storage->resetCache([
            $entity->id(),
        ]);
        $e = $storage->load($this->entityId);
        $field = $values = $e->getTranslation($langcode)->{$field_name};
        // Filter out empty values so that they don't mess with the assertions.
        $field->filterEmptyItems();
        $values = $field->getValue();
        $this->assertCount($expected_values_count, $values, 'Expected number of values were saved.');
        foreach ($expected_values as $key => $value) {
            $this->assertEquals($value, $values[$key][$column], new FormattableMarkup('Value @value was saved correctly.', [
                '@value' => $value,
            ]));
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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::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.
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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 24
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::setUp protected function Set the default field storage backend for fields created during tests. Overrides KernelTestBase::setUp 31
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 2
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 protected function Bootstraps a kernel for a test. 1
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. 2
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 28
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
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.