FieldImportDeleteTest.php

<?php

/**
 * @file
 * Contains \Drupal\field\Tests\FieldImportDeleteTest.
 */
namespace Drupal\field\Tests;


/**
 * Tests deleting fields and instances as part of config import.
 */
class FieldImportDeleteTest extends FieldUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field_test_config',
  );
  public static function getInfo() {
    return array(
      'name' => 'Field config delete tests',
      'description' => 'Delete field and instances during config delete method invocation.',
      'group' => 'Field API',
    );
  }

  /**
   * Tests deleting fields and instances as part of config import.
   */
  public function testImportDelete() {
    $field_id = 'field_test_import';
    $field_id_2 = 'field_test_import_2';
    $instance_id = "test_entity.test_bundle.{$field_id}";
    $instance_id_2a = "test_entity.test_bundle.{$field_id_2}";
    $instance_id_2b = "test_entity.test_bundle_2.{$field_id_2}";
    $field_config_name = "field.field.{$field_id}";
    $field_config_name_2 = "field.field.{$field_id_2}";
    $instance_config_name = "field.instance.{$instance_id}";
    $instance_config_name_2a = "field.instance.{$instance_id_2a}";
    $instance_config_name_2b = "field.instance.{$instance_id_2b}";

    // Create a second bundle for the 'Entity test' entity type.
    entity_test_create_bundle('test_bundle_2');

    // Import default config.
    $this
      ->installConfig(array(
      'field_test_config',
    ));

    // Get the uuid's for the fields.
    $field_uuid = entity_load('field_entity', $field_id)
      ->uuid();
    $field_uuid_2 = entity_load('field_entity', $field_id_2)
      ->uuid();
    $active = $this->container
      ->get('config.storage');
    $staging = $this->container
      ->get('config.storage.staging');
    $this
      ->copyConfig($active, $staging);
    $staging
      ->delete($field_config_name);
    $staging
      ->delete($field_config_name_2);
    $staging
      ->delete($instance_config_name);
    $staging
      ->delete($instance_config_name_2a);
    $staging
      ->delete($instance_config_name_2b);

    // Import the content of the staging directory.
    $this
      ->configImporter()
      ->import();

    // Check that the fields and instances are gone.
    $field = entity_load('field_entity', $field_id, TRUE);
    $this
      ->assertFalse($field, 'The field was deleted.');
    $field_2 = entity_load('field_entity', $field_id_2, TRUE);
    $this
      ->assertFalse($field_2, 'The second field was deleted.');
    $instance = entity_load('field_instance', $instance_id, TRUE);
    $this
      ->assertFalse($instance, 'The field instance was deleted.');
    $instance_2a = entity_load('field_instance', $instance_id_2a, TRUE);
    $this
      ->assertFalse($instance_2a, 'The second field instance on test bundle was deleted.');
    $instance_2b = entity_load('field_instance', $instance_id_2b, TRUE);
    $this
      ->assertFalse($instance_2b, 'The second field instance on test bundle 2 was deleted.');

    // Check that all config files are gone.
    $active = $this->container
      ->get('config.storage');
    $this
      ->assertIdentical($active
      ->listAll($field_config_name), array());
    $this
      ->assertIdentical($active
      ->listAll($field_config_name_2), array());
    $this
      ->assertIdentical($active
      ->listAll($instance_config_name), array());
    $this
      ->assertIdentical($active
      ->listAll($instance_config_name_2a), array());
    $this
      ->assertIdentical($active
      ->listAll($instance_config_name_2b), array());

    // Check that the field definition is preserved in state.
    $deleted_fields = \Drupal::state()
      ->get('field.field.deleted') ?: array();
    $this
      ->assertTrue(isset($deleted_fields[$field_uuid]));
    $this
      ->assertTrue(isset($deleted_fields[$field_uuid_2]));

    // Purge field data, and check that the field definition has been completely
    // removed once the data is purged.
    field_purge_batch(10);
    $deleted_fields = \Drupal::state()
      ->get('field.field.deleted') ?: array();
    $this
      ->assertTrue(empty($deleted_fields), 'Fields are deleted');
  }

}