class FieldWidgetConstraintValidatorTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Entity/FieldWidgetConstraintValidatorTest.php \Drupal\KernelTests\Core\Entity\FieldWidgetConstraintValidatorTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Entity/FieldWidgetConstraintValidatorTest.php \Drupal\KernelTests\Core\Entity\FieldWidgetConstraintValidatorTest
  3. 10 core/tests/Drupal/KernelTests/Core/Entity/FieldWidgetConstraintValidatorTest.php \Drupal\KernelTests\Core\Entity\FieldWidgetConstraintValidatorTest

Tests validation constraints for FieldWidgetConstraintValidatorTest.

@group Entity

Hierarchy

Expanded class hierarchy of FieldWidgetConstraintValidatorTest

File

core/tests/Drupal/KernelTests/Core/Entity/FieldWidgetConstraintValidatorTest.php, line 18

Namespace

Drupal\KernelTests\Core\Entity
View source
class FieldWidgetConstraintValidatorTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
        'field',
        'field_test',
        'user',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        $this->installEntitySchema('entity_test_composite_constraint');
    }
    
    /**
     * Tests widget constraint validation.
     */
    public function testValidation() : void {
        $entity_type = 'entity_test_constraint_violation';
        $entity = $this->container
            ->get('entity_type.manager')
            ->getStorage($entity_type)
            ->create([
            'id' => 1,
            'revision_id' => 1,
        ]);
        $display = \Drupal::service('entity_display.repository')->getFormDisplay($entity_type, $entity_type);
        $form = [];
        $form_state = new FormState();
        $display->buildForm($entity, $form, $form_state);
        // Pretend the form has been built.
        $form_state->setFormObject(\Drupal::entityTypeManager()->getFormObject($entity_type, 'default'));
        \Drupal::formBuilder()->prepareForm('field_test_entity_form', $form, $form_state);
        \Drupal::formBuilder()->processForm('field_test_entity_form', $form, $form_state);
        // Validate the field constraint.
        $form_state->getFormObject()
            ->setEntity($entity)
            ->setFormDisplay($display, $form_state);
        $entity = $form_state->getFormObject()
            ->buildEntity($form, $form_state);
        $display->validateFormValues($entity, $form, $form_state);
        $errors = $form_state->getErrors();
        $this->assertEquals('Widget constraint has failed.', $errors['name'], 'Constraint violation at the field items list level is generated correctly');
        $this->assertEquals('Widget constraint has failed.', $errors['test_field'], 'Constraint violation at the field items list level is generated correctly for an advanced widget');
    }
    
    /**
     * Gets the form errors for a given entity.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity
     * @param array $hidden_fields
     *   (optional) A list of hidden fields.
     *
     * @return array
     *   The form errors.
     */
    protected function getErrorsForEntity(EntityInterface $entity, $hidden_fields = []) {
        $entity_type_id = 'entity_test_composite_constraint';
        $display = \Drupal::service('entity_display.repository')->getFormDisplay($entity_type_id, $entity_type_id);
        foreach ($hidden_fields as $hidden_field) {
            $display->removeComponent($hidden_field);
        }
        $form = [];
        $form_state = new FormState();
        $display->buildForm($entity, $form, $form_state);
        $form_state->setFormObject(\Drupal::entityTypeManager()->getFormObject($entity_type_id, 'default'));
        \Drupal::formBuilder()->prepareForm('field_test_entity_form', $form, $form_state);
        \Drupal::formBuilder()->processForm('field_test_entity_form', $form, $form_state);
        // Validate the field constraint.
        
        /** @var \Drupal\Core\Entity\ContentEntityFormInterface $form_object */
        $form_object = $form_state->getFormObject();
        $form_object->setEntity($entity)
            ->setFormDisplay($display, $form_state)
            ->validateForm($form, $form_state);
        return $form_state->getErrors();
    }
    
    /**
     * Tests widget constraint validation with composite constraints.
     */
    public function testValidationWithCompositeConstraint() : void {
        // First provide a valid value, this should cause no validation.
        $entity = EntityTestCompositeConstraint::create([
            'name' => 'valid-value',
        ]);
        $entity->save();
        $errors = $this->getErrorsForEntity($entity);
        $this->assertFalse(isset($errors['name']));
        $this->assertFalse(isset($errors['type']));
        // Provide an invalid value for the name field.
        $entity = EntityTestCompositeConstraint::create([
            'name' => 'failure-field-name',
        ]);
        $errors = $this->getErrorsForEntity($entity);
        $this->assertTrue(isset($errors['name']));
        $this->assertFalse(isset($errors['type']));
        // Hide the second field (type) and ensure the validation still happens. The
        // error message appears on the first field (name).
        $entity = EntityTestCompositeConstraint::create([
            'name' => 'failure-field-name',
        ]);
        $errors = $this->getErrorsForEntity($entity, [
            'type',
        ]);
        $this->assertTrue(isset($errors['name']));
        $this->assertFalse(isset($errors['type']));
        // Provide a violation again, but this time hide the first field (name).
        // Ensure that the validation still happens and the error message is moved
        // from the field to the second field and have a custom error message.
        $entity = EntityTestCompositeConstraint::create([
            'name' => 'failure-field-name',
        ]);
        $errors = $this->getErrorsForEntity($entity, [
            'name',
        ]);
        $this->assertFalse(isset($errors['name']));
        $this->assertTrue(isset($errors['type']));
        $this->assertEquals(new FormattableMarkup('The validation failed because the value conflicts with the value in %field_name, which you cannot access.', [
            '%field_name' => 'name',
        ]), $errors['type']);
    }
    
    /**
     * Tests entity level constraint validation.
     */
    public function testEntityLevelConstraintValidation() : void {
        $entity = EntityTestCompositeConstraint::create([
            'name' => 'entity-level-violation',
        ]);
        $entity->save();
        $errors = $this->getErrorsForEntity($entity);
        $this->assertEquals('Entity level validation', $errors['']);
        $entity->name->value = 'entity-level-violation-with-path';
        $errors = $this->getErrorsForEntity($entity);
        $this->assertEquals('Entity level validation', $errors['test][form][element']);
    }

}

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.
FieldWidgetConstraintValidatorTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
FieldWidgetConstraintValidatorTest::getErrorsForEntity protected function Gets the form errors for a given entity.
FieldWidgetConstraintValidatorTest::setUp protected function Overrides KernelTestBase::setUp
FieldWidgetConstraintValidatorTest::testEntityLevelConstraintValidation public function Tests entity level constraint validation.
FieldWidgetConstraintValidatorTest::testValidation public function Tests widget constraint validation.
FieldWidgetConstraintValidatorTest::testValidationWithCompositeConstraint public function Tests widget constraint validation with composite constraints.
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.