ConfigEntityTest.php

<?php

namespace Drupal\Tests\config\Functional;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\Component\Uuid\Uuid;
use Drupal\Core\Entity\EntityMalformedException;
use Drupal\Core\Entity\EntityStorageException;
use Drupal\Core\Config\Entity\ConfigEntityStorage;
use Drupal\Core\Config\Entity\Exception\ConfigEntityIdLengthException;
use Drupal\Core\Url;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests configuration entities.
 *
 * @group config
 */
class ConfigEntityTest extends BrowserTestBase {
    
    /**
     * The maximum length for the entity storage used in this test.
     */
    const MAX_ID_LENGTH = ConfigEntityStorage::MAX_ID_LENGTH;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'config_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests CRUD operations.
     */
    public function testCRUD() {
        $default_langcode = \Drupal::languageManager()->getDefaultLanguage()
            ->getId();
        // Verify default properties on a newly created empty entity.
        $storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $empty = $storage->create();
        $this->assertIdentical($empty->label, NULL);
        $this->assertIdentical($empty->style, NULL);
        $this->assertIdentical($empty->language()
            ->getId(), $default_langcode);
        // Verify ConfigEntity properties/methods on the newly created empty entity.
        $this->assertIdentical($empty->isNew(), TRUE);
        $this->assertIdentical($empty->getOriginalId(), NULL);
        $this->assertIdentical($empty->bundle(), 'config_test');
        $this->assertIdentical($empty->id(), NULL);
        $this->assertTrue(Uuid::isValid($empty->uuid()));
        $this->assertIdentical($empty->label(), NULL);
        $this->assertIdentical($empty->get('id'), NULL);
        $this->assertTrue(Uuid::isValid($empty->get('uuid')));
        $this->assertIdentical($empty->get('label'), NULL);
        $this->assertIdentical($empty->get('style'), NULL);
        $this->assertIdentical($empty->language()
            ->getId(), $default_langcode);
        // Verify Entity properties/methods on the newly created empty entity.
        $this->assertIdentical($empty->getEntityTypeId(), 'config_test');
        // The URI can only be checked after saving.
        try {
            $empty->toUrl();
            $this->fail('EntityMalformedException was thrown.');
        } catch (EntityMalformedException $e) {
            // Expected exception; just continue testing.
        }
        // Verify that an empty entity cannot be saved.
        try {
            $empty->save();
            $this->fail('EntityMalformedException was thrown.');
        } catch (EntityMalformedException $e) {
            // Expected exception; just continue testing.
        }
        // Verify that an entity with an empty ID string is considered empty, too.
        $empty_id = $storage->create([
            'id' => '',
        ]);
        $this->assertIdentical($empty_id->isNew(), TRUE);
        try {
            $empty_id->save();
            $this->fail('EntityMalformedException was thrown.');
        } catch (EntityMalformedException $e) {
            // Expected exception; just continue testing.
        }
        // Verify properties on a newly created entity.
        $config_test = $storage->create($expected = [
            'id' => $this->randomMachineName(),
            'label' => $this->randomString(),
            'style' => $this->randomMachineName(),
        ]);
        $this->assertNotEqual($config_test->uuid(), $empty->uuid());
        $this->assertIdentical($config_test->label, $expected['label']);
        $this->assertIdentical($config_test->style, $expected['style']);
        $this->assertIdentical($config_test->language()
            ->getId(), $default_langcode);
        // Verify methods on the newly created entity.
        $this->assertIdentical($config_test->isNew(), TRUE);
        $this->assertIdentical($config_test->getOriginalId(), $expected['id']);
        $this->assertIdentical($config_test->id(), $expected['id']);
        $this->assertTrue(Uuid::isValid($config_test->uuid()));
        $expected['uuid'] = $config_test->uuid();
        $this->assertIdentical($config_test->label(), $expected['label']);
        // Verify that the entity can be saved.
        try {
            $status = $config_test->save();
        } catch (EntityMalformedException $e) {
            $this->fail('EntityMalformedException was not thrown.');
        }
        // The entity path can only be checked after saving.
        $this->assertIdentical($config_test->toUrl()
            ->toString(), Url::fromRoute('entity.config_test.edit_form', [
            'config_test' => $expected['id'],
        ])->toString());
        // Verify that the correct status is returned and properties did not change.
        $this->assertIdentical($status, SAVED_NEW);
        $this->assertIdentical($config_test->id(), $expected['id']);
        $this->assertIdentical($config_test->uuid(), $expected['uuid']);
        $this->assertIdentical($config_test->label(), $expected['label']);
        $this->assertIdentical($config_test->isNew(), FALSE);
        $this->assertIdentical($config_test->getOriginalId(), $expected['id']);
        // Save again, and verify correct status and properties again.
        $status = $config_test->save();
        $this->assertIdentical($status, SAVED_UPDATED);
        $this->assertIdentical($config_test->id(), $expected['id']);
        $this->assertIdentical($config_test->uuid(), $expected['uuid']);
        $this->assertIdentical($config_test->label(), $expected['label']);
        $this->assertIdentical($config_test->isNew(), FALSE);
        $this->assertIdentical($config_test->getOriginalId(), $expected['id']);
        // Verify that a configuration entity can be saved with an ID of the
        // maximum allowed length, but not longer.
        // Test with a short ID.
        $id_length_config_test = $storage->create([
            'id' => $this->randomMachineName(8),
        ]);
        try {
            $id_length_config_test->save();
        } catch (ConfigEntityIdLengthException $e) {
            $this->fail($e->getMessage());
        }
        // Test with an ID of the maximum allowed length.
        $id_length_config_test = $storage->create([
            'id' => $this->randomMachineName(static::MAX_ID_LENGTH),
        ]);
        try {
            $id_length_config_test->save();
        } catch (ConfigEntityIdLengthException $e) {
            $this->fail($e->getMessage());
        }
        // Test with an ID exceeding the maximum allowed length.
        $id_length_config_test = $storage->create([
            'id' => $this->randomMachineName(static::MAX_ID_LENGTH + 1),
        ]);
        try {
            $status = $id_length_config_test->save();
            $this->fail(new FormattableMarkup("config_test entity with ID length @length exceeding the maximum allowed length of @max saved successfully", [
                '@length' => strlen($id_length_config_test->id()),
                '@max' => static::MAX_ID_LENGTH,
            ]));
        } catch (ConfigEntityIdLengthException $e) {
            // Expected exception; just continue testing.
        }
        // Ensure that creating an entity with the same id as an existing one is not
        // possible.
        $same_id = $storage->create([
            'id' => $config_test->id(),
        ]);
        $this->assertIdentical($same_id->isNew(), TRUE);
        try {
            $same_id->save();
            $this->fail('Not possible to overwrite an entity entity.');
        } catch (EntityStorageException $e) {
            // Expected exception; just continue testing.
        }
        // Verify that renaming the ID returns correct status and properties.
        $ids = [
            $expected['id'],
            'second_' . $this->randomMachineName(4),
            'third_' . $this->randomMachineName(4),
        ];
        for ($i = 1; $i < 3; $i++) {
            $old_id = $ids[$i - 1];
            $new_id = $ids[$i];
            // Before renaming, everything should point to the current ID.
            $this->assertIdentical($config_test->id(), $old_id);
            $this->assertIdentical($config_test->getOriginalId(), $old_id);
            // Rename.
            $config_test->set('id', $new_id);
            $this->assertIdentical($config_test->id(), $new_id);
            $status = $config_test->save();
            $this->assertIdentical($status, SAVED_UPDATED);
            $this->assertIdentical($config_test->isNew(), FALSE);
            // Verify that originalID points to new ID directly after renaming.
            $this->assertIdentical($config_test->id(), $new_id);
            $this->assertIdentical($config_test->getOriginalId(), $new_id);
        }
        // Test config entity prepopulation.
        \Drupal::state()->set('config_test.prepopulate', TRUE);
        $config_test = $storage->create([
            'foo' => 'bar',
        ]);
        $this->assertEquals('baz', $config_test->get('foo'), 'Initial value correctly populated');
    }
    
    /**
     * Tests CRUD operations through the UI.
     */
    public function testCRUDUI() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
        ]));
        $id = strtolower($this->randomMachineName());
        $label1 = $this->randomMachineName();
        $label2 = $this->randomMachineName();
        $label3 = $this->randomMachineName();
        $message_insert = new FormattableMarkup('%label configuration has been created.', [
            '%label' => $label1,
        ]);
        $message_update = new FormattableMarkup('%label configuration has been updated.', [
            '%label' => $label2,
        ]);
        $message_delete = new FormattableMarkup('The test configuration %label has been deleted.', [
            '%label' => $label2,
        ]);
        // Create a configuration entity.
        $edit = [
            'id' => $id,
            'label' => $label1,
        ];
        $this->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
        $this->assertUrl('admin/structure/config_test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertRaw($message_insert);
        $this->assertNoRaw($message_update);
        $this->assertLinkByHref("admin/structure/config_test/manage/{$id}");
        // Update the configuration entity.
        $edit = [
            'label' => $label2,
        ];
        $this->drupalPostForm("admin/structure/config_test/manage/{$id}", $edit, 'Save');
        $this->assertUrl('admin/structure/config_test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertNoRaw($message_insert);
        $this->assertRaw($message_update);
        $this->assertLinkByHref("admin/structure/config_test/manage/{$id}");
        $this->assertLinkByHref("admin/structure/config_test/manage/{$id}/delete");
        // Delete the configuration entity.
        $this->drupalGet("admin/structure/config_test/manage/{$id}");
        $this->clickLink(t('Delete'));
        $this->assertUrl("admin/structure/config_test/manage/{$id}/delete");
        $this->drupalPostForm(NULL, [], 'Delete');
        $this->assertUrl('admin/structure/config_test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertNoRaw($message_update);
        $this->assertRaw($message_delete);
        $this->assertNoText($label1);
        $this->assertNoLinkByHref("admin/structure/config_test/manage/{$id}");
        // Re-create a configuration entity.
        $edit = [
            'id' => $id,
            'label' => $label1,
        ];
        $this->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
        $this->assertUrl('admin/structure/config_test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertText($label1);
        $this->assertLinkByHref("admin/structure/config_test/manage/{$id}");
        // Rename the configuration entity's ID/machine name.
        $edit = [
            'id' => strtolower($this->randomMachineName()),
            'label' => $label3,
        ];
        $this->drupalPostForm("admin/structure/config_test/manage/{$id}", $edit, 'Save');
        $this->assertUrl('admin/structure/config_test');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertNoText($label1);
        $this->assertNoText($label2);
        $this->assertText($label3);
        $this->assertNoLinkByHref("admin/structure/config_test/manage/{$id}");
        $id = $edit['id'];
        $this->assertLinkByHref("admin/structure/config_test/manage/{$id}");
        // Create a configuration entity with '0' machine name.
        $edit = [
            'id' => '0',
            'label' => '0',
        ];
        $this->drupalPostForm('admin/structure/config_test/add', $edit, 'Save');
        $this->assertSession()
            ->statusCodeEquals(200);
        $message_insert = new FormattableMarkup('%label configuration has been created.', [
            '%label' => $edit['label'],
        ]);
        $this->assertRaw($message_insert);
        $this->assertLinkByHref('admin/structure/config_test/manage/0');
        $this->assertLinkByHref('admin/structure/config_test/manage/0/delete');
        $this->drupalPostForm('admin/structure/config_test/manage/0/delete', [], 'Delete');
        $storage = \Drupal::entityTypeManager()->getStorage('config_test');
        $this->assertNull($storage->load(0), 'Test entity deleted');
        // Create a configuration entity with a property that uses AJAX to show
        // extra form elements. Test this scenario in a non-JS case by using a
        // 'js-hidden' submit button.
        // @see \Drupal\Tests\config\FunctionalJavascript\ConfigEntityTest::testAjaxOnAddPage()
        $this->drupalGet('admin/structure/config_test/add');
        $id = strtolower($this->randomMachineName());
        $edit = [
            'id' => $id,
            'label' => $this->randomString(),
            'size' => 'custom',
        ];
        $this->assertFieldByName('size');
        $this->assertNoFieldByName('size_value');
        $this->drupalPostForm(NULL, $edit, 'Change size');
        $this->assertFieldByName('size');
        $this->assertFieldByName('size_value');
        // Submit the form with the regular 'Save' button and check that the entity
        // values are correct.
        $edit += [
            'size_value' => 'medium',
        ];
        $this->drupalPostForm(NULL, $edit, 'Save');
        $entity = $storage->load($id);
        $this->assertEquals('custom', $entity->get('size'));
        $this->assertEquals('medium', $entity->get('size_value'));
    }

}