class NumberItemTest

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

Tests the new entity API for the number field type.

@group field

Hierarchy

Expanded class hierarchy of NumberItemTest

File

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

Namespace

Drupal\Tests\field\Kernel\Number
View source
class NumberItemTest extends FieldKernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create number field storages and fields for validation.
        foreach ([
            'integer',
            'float',
            'decimal',
        ] as $type) {
            FieldStorageConfig::create([
                'entity_type' => 'entity_test',
                'field_name' => 'field_' . $type,
                'type' => $type,
            ])->save();
            FieldConfig::create([
                'entity_type' => 'entity_test',
                'field_name' => 'field_' . $type,
                'bundle' => 'entity_test',
            ])->save();
        }
    }
    
    /**
     * Tests using entity fields of the number field type.
     */
    public function testNumberItem() {
        // Verify entity creation.
        $entity = EntityTest::create();
        $integer = rand(0, 10);
        $entity->field_integer = $integer;
        $float = 3.14;
        $entity->field_float = $float;
        $entity->field_decimal = '20-40';
        $violations = $entity->validate();
        $this->assertCount(1, $violations, 'Wrong decimal value causes validation error');
        $decimal = '31.3';
        $entity->field_decimal = $decimal;
        $entity->name->value = $this->randomMachineName();
        $entity->save();
        // Verify entity has been created properly.
        $id = $entity->id();
        $entity = EntityTest::load($id);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_integer);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_integer[0]);
        $this->assertEquals($integer, $entity->field_integer->value);
        $this->assertEquals($integer, $entity->field_integer[0]->value);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_float);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_float[0]);
        $this->assertEquals($float, $entity->field_float->value);
        $this->assertEquals($float, $entity->field_float[0]->value);
        $this->assertInstanceOf(FieldItemListInterface::class, $entity->field_decimal);
        $this->assertInstanceOf(FieldItemInterface::class, $entity->field_decimal[0]);
        $this->assertEquals((double) $decimal, $entity->field_decimal->value);
        $this->assertEquals((double) $decimal, $entity->field_decimal[0]->value);
        // Verify changing the number value.
        $new_integer = rand(11, 20);
        $new_float = rand(1001, 2000) / 100;
        $new_decimal = '18.2';
        $entity->field_integer->value = $new_integer;
        $this->assertEquals($new_integer, $entity->field_integer->value);
        $entity->field_float->value = $new_float;
        $this->assertEquals($new_float, $entity->field_float->value);
        $entity->field_decimal->value = $new_decimal;
        $this->assertEquals((double) $new_decimal, $entity->field_decimal->value);
        // Read changed entity and assert changed values.
        $entity->save();
        $entity = EntityTest::load($id);
        $this->assertEquals($new_integer, $entity->field_integer->value);
        $this->assertEquals($new_float, $entity->field_float->value);
        $this->assertEquals((double) $new_decimal, $entity->field_decimal->value);
        // Test sample item generation.
        $entity = EntityTest::create();
        // Make sure that field settings are respected by the generation.
        $entity->field_decimal
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_float
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_integer
            ->getFieldDefinition()
            ->setSetting('min', 99)
            ->setSetting('max', 100);
        $entity->field_decimal
            ->generateSampleItems();
        $entity->field_integer
            ->generateSampleItems();
        $entity->field_float
            ->generateSampleItems();
        // Confirm that the generated sample values are within range.
        $this->entityValidateAndSave($entity);
    }
    
    /**
     * Tests constraints on numeric item fields.
     *
     * @dataProvider dataNumberFieldSettingsProvider
     *
     * @param string $type
     *   The field type.
     * @param int|float $min
     *   The minimum field value.
     * @param int|float $max
     *   The maximum field value.
     * @param int|float $value
     *   The test value.
     * @param bool $expect_constraints
     *   If TRUE this data set will trigger a validation constraint.
     * @param string $expected_constraint_message
     *   The expected constraint violation message.
     *
     * @throws \Drupal\Core\Entity\EntityStorageException
     */
    public function testConstraints($type, $min, $max, $value, $expect_constraints, $expected_constraint_message = '') {
        $field = FieldConfig::loadByName('entity_test', 'entity_test', 'field_' . $type);
        $field->setSetting('min', $min);
        $field->setSetting('max', $max);
        $field->save();
        $entity = EntityTest::create();
        $entity->{'field_' . $type} = $value;
        $violations = $entity->validate();
        $this->assertEquals($expect_constraints, $violations->count() > 0);
        if ($expect_constraints) {
            $this->assertEquals($expected_constraint_message, $violations->get(0)
                ->getMessage());
        }
    }
    
    /**
     * Data provider for testConstraints.
     *
     * @return \Generator
     *   The test data.
     */
    public function dataNumberFieldSettingsProvider() {
        (yield [
            'integer',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'integer',
            0,
            NULL,
            -100,
            TRUE,
            '<em class="placeholder">field_integer</em>: the value may be no less than <em class="placeholder">0</em>.',
        ]);
        (yield [
            'integer',
            10,
            NULL,
            100,
            FALSE,
        ]);
        (yield [
            'integer',
            10,
            NULL,
            5,
            TRUE,
            '<em class="placeholder">field_integer</em>: the value may be no less than <em class="placeholder">10</em>.',
        ]);
        (yield [
            'integer',
            10,
            20,
            25,
            TRUE,
            '<em class="placeholder">field_integer</em>: the value may be no greater than <em class="placeholder">20</em>.',
        ]);
        (yield [
            'integer',
            10,
            20,
            15,
            FALSE,
        ]);
        (yield [
            'float',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'float',
            0.003,
            NULL,
            0.0029,
            TRUE,
            '<em class="placeholder">field_float</em>: the value may be no less than <em class="placeholder">0.003</em>.',
        ]);
        (yield [
            'float',
            10.05,
            NULL,
            13.4,
            FALSE,
        ]);
        (yield [
            'float',
            10,
            NULL,
            9.999000000000001,
            TRUE,
            '<em class="placeholder">field_float</em>: the value may be no less than <em class="placeholder">10</em>.',
        ]);
        (yield [
            'float',
            1,
            2,
            2.5,
            TRUE,
            '<em class="placeholder">field_float</em>: the value may be no greater than <em class="placeholder">2</em>.',
        ]);
        (yield [
            'float',
            1,
            2,
            1.5,
            FALSE,
        ]);
        (yield [
            'decimal',
            NULL,
            NULL,
            -100,
            FALSE,
        ]);
        (yield [
            'decimal',
            0.001,
            NULL,
            -0.05,
            TRUE,
            '<em class="placeholder">field_decimal</em>: the value may be no less than <em class="placeholder">0.001</em>.',
        ]);
        (yield [
            'decimal',
            10.05,
            NULL,
            13.4,
            FALSE,
        ]);
        (yield [
            'decimal',
            10,
            NULL,
            9.999000000000001,
            TRUE,
            '<em class="placeholder">field_decimal</em>: the value may be no less than <em class="placeholder">10</em>.',
        ]);
        (yield [
            'decimal',
            1,
            2,
            2.5,
            TRUE,
            '<em class="placeholder">field_decimal</em>: the value may be no greater than <em class="placeholder">2</em>.',
        ]);
        (yield [
            'decimal',
            1,
            2,
            1.5,
            FALSE,
        ]);
    }

}

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 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 raw text IS NOT found escaped on 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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
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::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::_generateTestFieldValues protected function Generate random values for a field_test field.
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. 6
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::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 7
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. 3
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::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. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
NumberItemTest::$modules protected static property Modules to enable. Overrides FieldKernelTestBase::$modules
NumberItemTest::dataNumberFieldSettingsProvider public function Data provider for testConstraints.
NumberItemTest::setUp protected function Set the default field storage backend for fields created during tests. Overrides FieldKernelTestBase::setUp
NumberItemTest::testConstraints public function Tests constraints on numeric item fields.
NumberItemTest::testNumberItem public function Tests using entity fields of the number field type.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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.