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