ConfigEntityUnitTest.php

<?php

namespace Drupal\KernelTests\Core\Config;

use Drupal\KernelTests\KernelTestBase;

/**
 * Unit tests for configuration entity base methods.
 *
 * @group config
 */
class ConfigEntityUnitTest extends KernelTestBase {
    
    /**
     * Exempt from strict schema checking.
     *
     * @see \Drupal\Core\Config\Development\ConfigSchemaChecker
     *
     * @var bool
     */
    protected $strictConfigSchema = FALSE;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'config_test',
    ];
    
    /**
     * The config_test entity storage.
     *
     * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
     */
    protected $storage;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('config_test');
    }
    
    /**
     * Tests storage methods.
     */
    public function testStorageMethods() {
        $entity_type = \Drupal::entityTypeManager()->getDefinition('config_test');
        // Test the static extractID() method.
        $expected_id = 'test_id';
        $config_name = $entity_type->getConfigPrefix() . '.' . $expected_id;
        $storage = $this->storage;
        $this->assertSame($expected_id, $storage::getIDFromConfigName($config_name, $entity_type->getConfigPrefix()));
        // Create three entities, two with the same style.
        $style = $this->randomMachineName(8);
        for ($i = 0; $i < 2; $i++) {
            $entity = $this->storage
                ->create([
                'id' => $this->randomMachineName(),
                'label' => $this->randomString(),
                'style' => $style,
            ]);
            $entity->save();
        }
        $entity = $this->storage
            ->create([
            'id' => $this->randomMachineName(),
            'label' => $this->randomString(),
            // Use a different length for the entity to ensure uniqueness.
'style' => $this->randomMachineName(9),
        ]);
        $entity->save();
        // Ensure that the configuration entity can be loaded by UUID.
        $entity_loaded_by_uuid = \Drupal::service('entity.repository')->loadEntityByUuid($entity_type->id(), $entity->uuid());
        if (!$entity_loaded_by_uuid) {
            $this->fail(sprintf("Failed to load '%s' entity ID '%s' by UUID '%s'.", $entity_type->id(), $entity->id(), $entity->uuid()));
        }
        // Compare UUIDs as the objects are not identical since
        // $entity->enforceIsNew is FALSE and $entity_loaded_by_uuid->enforceIsNew
        // is NULL.
        $this->assertSame($entity->uuid(), $entity_loaded_by_uuid->uuid());
        $entities = $this->storage
            ->loadByProperties();
        $this->assertCount(3, $entities, 'Three entities are loaded when no properties are specified.');
        $entities = $this->storage
            ->loadByProperties([
            'style' => $style,
        ]);
        $this->assertCount(2, $entities, 'Two entities are loaded when the style property is specified.');
        // Assert that both returned entities have a matching style property.
        foreach ($entities as $entity) {
            $this->assertSame($style, $entity->get('style'), 'The loaded entity has the correct style value specified.');
        }
        // Test that schema type enforcement can be overridden by trusting the data.
        $entity = $this->storage
            ->create([
            'id' => $this->randomMachineName(),
            'label' => $this->randomString(),
            'style' => 999,
        ]);
        $entity->save();
        $this->assertSame('999', $entity->style);
        $entity->style = 999;
        $entity->trustData()
            ->save();
        $this->assertSame(999, $entity->style);
        $entity->save();
        $this->assertSame('999', $entity->style);
    }

}