class FieldImportDeleteUninstallUiTest in Drupal 10

Delete field storages and fields during config synchronization and uninstall module that provides the field type through the UI.

@group field

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\field\Functional\FieldTestBase
    • class \Drupal\Tests\field\Functional\FieldImportDeleteUninstallUiTest

See also

\Drupal\field\ConfigImporterFieldPurger

field_config_import_steps_alter()

field_form_config_admin_import_form_alter()

File

core/modules/field/tests/src/Functional/FieldImportDeleteUninstallUiTest.php, line 18

Namespace

Drupal\Tests\field\Functional

class FieldImportDeleteUninstallUiTest extends FieldTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'entity_test',
    'telephone',
    'config',
    'filter',
    'datetime',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  protected function setUp() : void {
    parent::setUp();
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'synchronize configuration',
    ]));
  }

  /**
   * Tests deleting field storages and fields as part of config import.
   */
  public function testImportDeleteUninstall() {

    // Create a telephone field.
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'field_tel',
      'entity_type' => 'entity_test',
      'type' => 'telephone',
    ]);
    $field_storage
      ->save();
    FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'entity_test',
    ])
      ->save();

    // Create a text field.
    $date_field_storage = FieldStorageConfig::create([
      'field_name' => 'field_date',
      'entity_type' => 'entity_test',
      'type' => 'datetime',
    ]);
    $date_field_storage
      ->save();
    FieldConfig::create([
      'field_storage' => $date_field_storage,
      'bundle' => 'entity_test',
    ])
      ->save();

    // Create an entity which has values for the telephone and text field.
    $entity = EntityTest::create();
    $value = '+0123456789';
    $entity->field_tel = $value;
    $entity->field_date = time();
    $entity->name->value = $this
      ->randomMachineName();
    $entity
      ->save();

    // Delete the text field before exporting configuration so that we can test
    // that deleted fields that are provided by modules that will be uninstalled
    // are also purged and that the UI message includes such fields.
    $date_field_storage
      ->delete();

    // Verify entity has been created properly.
    $id = $entity
      ->id();
    $entity = EntityTest::load($id);
    $this
      ->assertEquals($value, $entity->field_tel->value);
    $this
      ->assertEquals($value, $entity->field_tel[0]->value);
    $active = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');
    $this
      ->copyConfig($active, $sync);

    // Stage uninstall of the Telephone module.
    $core_extension = $this
      ->config('core.extension')
      ->get();
    unset($core_extension['module']['telephone']);
    $sync
      ->write('core.extension', $core_extension);

    // Stage the field deletion including its dependencies.
    $sync
      ->delete('field.storage.entity_test.field_tel');
    $sync
      ->delete('field.field.entity_test.entity_test.field_tel');
    $sync
      ->delete('core.entity_form_display.entity_test.entity_test.default');
    $this
      ->drupalGet('admin/config/development/configuration');

    // Test that the message for one field being purged during a configuration
    // synchronization is correct.
    $this
      ->assertSession()
      ->pageTextContains('This synchronization will delete data from the field entity_test.field_tel.');

    // Stage an uninstall of the datetime module to test the message for
    // multiple fields.
    unset($core_extension['module']['datetime']);
    $sync
      ->write('core.extension', $core_extension);
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertSession()
      ->pageTextContains('This synchronization will delete data from the fields: entity_test.field_tel, entity_test.field_date.');

    // This will purge all the data, delete the field and uninstall the
    // Telephone and Text modules.
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextNotContains('Field data will be deleted by this synchronization.');
    $this
      ->rebuildContainer();
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('telephone'));
    $this
      ->assertNull(\Drupal::service('entity.repository')
      ->loadEntityByUuid('field_storage_config', $field_storage
      ->uuid()), 'The telephone field has been deleted by the configuration synchronization');
    $deleted_storages = \Drupal::state()
      ->get('field.storage.deleted', []);
    $this
      ->assertFalse(isset($deleted_storages[$field_storage
      ->uuid()]), 'Telephone field has been completed removed from the system.');
    $this
      ->assertFalse(isset($deleted_storages[$field_storage
      ->uuid()]), 'Text field has been completed removed from the system.');
  }

}