public function ConfigEntityTest::testCRUD in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/config/tests/src/Functional/ConfigEntityTest.php \Drupal\Tests\config\Functional\ConfigEntityTest::testCRUD()

Tests CRUD operations.

File

core/modules/config/tests/src/Functional/ConfigEntityTest.php, line 41

Class

ConfigEntityTest

Tests configuration entities.

Namespace

Drupal\Tests\config\Functional

Code

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
    ->assertNull($empty->label);
  $this
    ->assertNull($empty->style);
  $this
    ->assertSame($default_langcode, $empty
    ->language()
    ->getId());

  // Verify ConfigEntity properties/methods on the newly created empty entity.
  $this
    ->assertTrue($empty
    ->isNew());
  $this
    ->assertNull($empty
    ->getOriginalId());
  $this
    ->assertSame('config_test', $empty
    ->bundle());
  $this
    ->assertNull($empty
    ->id());
  $this
    ->assertTrue(Uuid::isValid($empty
    ->uuid()));
  $this
    ->assertNull($empty
    ->label());
  $this
    ->assertNull($empty
    ->get('id'));
  $this
    ->assertTrue(Uuid::isValid($empty
    ->get('uuid')));
  $this
    ->assertNull($empty
    ->get('label'));
  $this
    ->assertNull($empty
    ->get('style'));
  $this
    ->assertSame($default_langcode, $empty
    ->language()
    ->getId());

  // Verify Entity properties/methods on the newly created empty entity.
  $this
    ->assertSame('config_test', $empty
    ->getEntityTypeId());

  // 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
    ->assertTrue($empty_id
    ->isNew());
  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
    ->assertNotEquals($empty
    ->uuid(), $config_test
    ->uuid());
  $this
    ->assertSame($expected['label'], $config_test->label);
  $this
    ->assertSame($expected['style'], $config_test->style);
  $this
    ->assertSame($default_langcode, $config_test
    ->language()
    ->getId());

  // Verify methods on the newly created entity.
  $this
    ->assertTrue($config_test
    ->isNew());
  $this
    ->assertSame($expected['id'], $config_test
    ->getOriginalId());
  $this
    ->assertSame($expected['id'], $config_test
    ->id());
  $this
    ->assertTrue(Uuid::isValid($config_test
    ->uuid()));
  $expected['uuid'] = $config_test
    ->uuid();
  $this
    ->assertSame($expected['label'], $config_test
    ->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
    ->assertSame(Url::fromRoute('entity.config_test.edit_form', [
    'config_test' => $expected['id'],
  ])
    ->toString(), $config_test
    ->toUrl()
    ->toString());

  // Verify that the correct status is returned and properties did not change.
  $this
    ->assertSame(SAVED_NEW, $status);
  $this
    ->assertSame($expected['id'], $config_test
    ->id());
  $this
    ->assertSame($expected['uuid'], $config_test
    ->uuid());
  $this
    ->assertSame($expected['label'], $config_test
    ->label());
  $this
    ->assertFalse($config_test
    ->isNew());
  $this
    ->assertSame($expected['id'], $config_test
    ->getOriginalId());

  // Save again, and verify correct status and properties again.
  $status = $config_test
    ->save();
  $this
    ->assertSame(SAVED_UPDATED, $status);
  $this
    ->assertSame($expected['id'], $config_test
    ->id());
  $this
    ->assertSame($expected['uuid'], $config_test
    ->uuid());
  $this
    ->assertSame($expected['label'], $config_test
    ->label());
  $this
    ->assertFalse($config_test
    ->isNew());
  $this
    ->assertSame($expected['id'], $config_test
    ->getOriginalId());

  // 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
    ->assertTrue($same_id
    ->isNew());
  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
      ->assertSame($old_id, $config_test
      ->id());
    $this
      ->assertSame($old_id, $config_test
      ->getOriginalId());

    // Rename.
    $config_test
      ->set('id', $new_id);
    $this
      ->assertSame($new_id, $config_test
      ->id());
    $status = $config_test
      ->save();
    $this
      ->assertSame(SAVED_UPDATED, $status);
    $this
      ->assertFalse($config_test
      ->isNew());

    // Verify that originalID points to new ID directly after renaming.
    $this
      ->assertSame($new_id, $config_test
      ->id());
    $this
      ->assertSame($new_id, $config_test
      ->getOriginalId());
  }

  // 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');
}