class FieldImportDeleteTest

Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/FieldImportDeleteTest.php \Drupal\Tests\field\Kernel\FieldImportDeleteTest
  2. 8.9.x core/modules/field/tests/src/Kernel/FieldImportDeleteTest.php \Drupal\Tests\field\Kernel\FieldImportDeleteTest
  3. 11.x core/modules/field/tests/src/Kernel/FieldImportDeleteTest.php \Drupal\Tests\field\Kernel\FieldImportDeleteTest

Delete field storages and fields during config delete method invocation.

@group field

Hierarchy

Expanded class hierarchy of FieldImportDeleteTest

File

core/modules/field/tests/src/Kernel/FieldImportDeleteTest.php, line 16

Namespace

Drupal\Tests\field\Kernel
View source
class FieldImportDeleteTest extends FieldKernelTestBase {
    
    /**
     * Modules to install.
     *
     * The default configuration provided by field_test_config is imported by
     * \Drupal\Tests\field\Kernel\FieldKernelTestBase::setUp() when it installs
     * field configuration.
     *
     * @var array
     */
    protected static $modules = [
        'field_test_config',
    ];
    
    /**
     * Tests deleting field storages and fields as part of config import.
     */
    public function testImportDelete() : void {
        entity_test_create_bundle('test_bundle');
        $this->installConfig([
            'field_test_config',
        ]);
        // At this point there are 5 field configuration objects in the active
        // storage.
        // - field.storage.entity_test.field_test_import
        // - field.storage.entity_test.field_test_import_2
        // - field.field.entity_test.entity_test.field_test_import
        // - field.field.entity_test.entity_test.field_test_import_2
        // - field.field.entity_test.test_bundle.field_test_import_2
        $field_name = 'field_test_import';
        $field_storage_id = "entity_test.{$field_name}";
        $field_name_2 = 'field_test_import_2';
        $field_storage_id_2 = "entity_test.{$field_name_2}";
        $field_id = "entity_test.entity_test.{$field_name}";
        $field_id_2a = "entity_test.entity_test.{$field_name_2}";
        $field_id_2b = "entity_test.test_bundle.{$field_name_2}";
        $field_storage_config_name = "field.storage.{$field_storage_id}";
        $field_storage_config_name_2 = "field.storage.{$field_storage_id_2}";
        $field_config_name = "field.field.{$field_id}";
        $field_config_name_2a = "field.field.{$field_id_2a}";
        $field_config_name_2b = "field.field.{$field_id_2b}";
        // Create an entity with data in the first field to make sure that field
        // needs to be purged.
        $entity_test = EntityTest::create([
            'type' => 'entity_test',
        ]);
        $entity_test->set($field_name, 'test data');
        $entity_test->save();
        // Create a second bundle for the 'Entity test' entity type.
        entity_test_create_bundle('test_bundle');
        // Get the uuid's for the field storages.
        $field_storage_uuid = FieldStorageConfig::load($field_storage_id)->uuid();
        $field_storage_uuid_2 = FieldStorageConfig::load($field_storage_id_2)->uuid();
        $active = $this->container
            ->get('config.storage');
        $sync = $this->container
            ->get('config.storage.sync');
        $this->copyConfig($active, $sync);
        $this->assertTrue($sync->delete($field_storage_config_name), "Deleted field storage: {$field_storage_config_name}");
        $this->assertTrue($sync->delete($field_storage_config_name_2), "Deleted field storage: {$field_storage_config_name_2}");
        $this->assertTrue($sync->delete($field_config_name), "Deleted field: {$field_config_name}");
        $this->assertTrue($sync->delete($field_config_name_2a), "Deleted field: {$field_config_name_2a}");
        $this->assertTrue($sync->delete($field_config_name_2b), "Deleted field: {$field_config_name_2b}");
        $deletes = $this->configImporter()
            ->getUnprocessedConfiguration('delete');
        $this->assertCount(5, $deletes, 'Importing configuration will delete 3 fields and 2 field storages.');
        // Import the content of the sync directory.
        $this->configImporter()
            ->import();
        // Check that the field storages and fields are gone.
        \Drupal::entityTypeManager()->getStorage('field_storage_config')
            ->resetCache([
            $field_storage_id,
        ]);
        $field_storage = FieldStorageConfig::load($field_storage_id);
        $this->assertNull($field_storage, 'The field storage was deleted.');
        \Drupal::entityTypeManager()->getStorage('field_storage_config')
            ->resetCache([
            $field_storage_id_2,
        ]);
        $field_storage_2 = FieldStorageConfig::load($field_storage_id_2);
        $this->assertNull($field_storage_2, 'The second field storage was deleted.');
        \Drupal::entityTypeManager()->getStorage('field_config')
            ->resetCache([
            $field_id,
        ]);
        $field = FieldConfig::load($field_id);
        $this->assertNull($field, 'The field was deleted.');
        \Drupal::entityTypeManager()->getStorage('field_config')
            ->resetCache([
            $field_id_2a,
        ]);
        $field_2a = FieldConfig::load($field_id_2a);
        $this->assertNull($field_2a, 'The second field on test bundle was deleted.');
        \Drupal::entityTypeManager()->getStorage('field_config')
            ->resetCache([
            $field_id_2b,
        ]);
        $field_2b = FieldConfig::load($field_id_2b);
        $this->assertNull($field_2b, 'The second field on test bundle 2 was deleted.');
        // Check that all config files are gone.
        $active = $this->container
            ->get('config.storage');
        $this->assertSame([], $active->listAll($field_storage_config_name));
        $this->assertSame([], $active->listAll($field_storage_config_name_2));
        $this->assertSame([], $active->listAll($field_config_name));
        $this->assertSame([], $active->listAll($field_config_name_2a));
        $this->assertSame([], $active->listAll($field_config_name_2b));
        // Check that only the first storage definition is preserved in state.
        $deleted_storages = \Drupal::state()->get('field.storage.deleted', []);
        $this->assertTrue(isset($deleted_storages[$field_storage_uuid]));
        $this->assertFalse(isset($deleted_storages[$field_storage_uuid_2]));
        // Purge field data, and check that the storage definition has been
        // completely removed once the data is purged.
        field_purge_batch(10);
        $deleted_storages = \Drupal::state()->get('field.storage.deleted', []);
        $this->assertEmpty($deleted_storages, 'Fields are deleted');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldImportDeleteTest::$modules protected static property Modules to install. Overrides FieldKernelTestBase::$modules
FieldImportDeleteTest::testImportDelete public function Tests deleting field storages and fields as part of config import.
FieldKernelTestBase::$entityId protected property
FieldKernelTestBase::$fieldTestData protected property Bag of created field storages and fields.
FieldKernelTestBase::assertFieldValues protected function Assert that a field has the expected values in an entity.
FieldKernelTestBase::createFieldWithStorage protected function Create a field and an associated field storage.
FieldKernelTestBase::entitySaveReload protected function Saves and reloads an entity.
FieldKernelTestBase::entityValidateAndSave protected function Validate and save entity. Fail if violations are found.
FieldKernelTestBase::setUp protected function Set the default field storage backend for fields created during tests. Overrides KernelTestBase::setUp 31
FieldKernelTestBase::_generateTestFieldValues protected function Generate random values for a field_test field.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.