You are here

Home » API reference » Zircon Profile 8 » ConfigDependencyTest.php

class ConfigDependencyTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/config/src/Tests/ConfigDependencyTest.php \Drupal\config\Tests\ConfigDependencyTest

Tests for configuration dependencies.

@group config

Hierarchy

Expanded class hierarchy of ConfigDependencyTest

File

core/modules/config/src/Tests/ConfigDependencyTest.php, line 18
Contains \Drupal\config\Tests\ConfigDependencyTest.

Namespace

Drupal\config\Tests
View source 
class ConfigDependencyTest extends EntityUnitTestBase {

  /**
   * Modules to enable.
   *
   * The entity_test module is enabled to provide content entity types.
   *
   * @var array
   */
  public static $modules = array(
    'config_test',
    'entity_test',
    'user',
  );

  /**
   * Tests that calculating dependencies for system module.
   */
  public function testNonEntity() {
    $this
      ->installConfig(array(
      'system',
    ));
    $config_manager = \Drupal::service('config.manager');
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'system',
    ));
    $this
      ->assertTrue(isset($dependents['system.site']), 'Simple configuration system.site has a UUID key even though it is not a configuration entity and therefore is found when looking for dependencies of the System module.');

    // Ensure that calling
    // \Drupal\Core\Config\ConfigManager::findConfigEntityDependentsAsEntities()
    // does not try to load system.site as an entity.
    $config_manager
      ->findConfigEntityDependentsAsEntities('module', array(
      'system',
    ));
  }

  /**
   * Tests creating dependencies on configuration entities.
   */
  public function testDependencyManagement() {

    /** @var \Drupal\Core\Config\ConfigManagerInterface $config_manager */
    $config_manager = \Drupal::service('config.manager');
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('config_test');

    // Test dependencies between modules.
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
      'dependencies' => array(
        'enforced' => array(
          'module' => array(
            'node',
          ),
        ),
      ),
    ));
    $entity1
      ->save();
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'node',
    ));
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 has a dependency on the Node module.');
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'config_test',
    ));
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 has a dependency on the config_test module.');
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'views',
    ));
    $this
      ->assertFalse(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 does not have a dependency on the Views module.');

    // Ensure that the provider of the config entity is not actually written to
    // the dependencies array.
    $raw_config = $this
      ->config('config_test.dynamic.entity1');
    $root_module_dependencies = $raw_config
      ->get('dependencies.module');
    $this
      ->assertTrue(empty($root_module_dependencies), 'Node module is not written to the root dependencies array as it is enforced.');

    // Create additional entities to test dependencies on config entities.
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();
    $entity3 = $storage
      ->create(array(
      'id' => 'entity3',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity2
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity3
      ->save();
    $entity4 = $storage
      ->create(array(
      'id' => 'entity4',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity3
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity4
      ->save();

    // Test getting $entity1's dependencies as configuration dependency objects.
    $dependents = $config_manager
      ->findConfigEntityDependents('config', array(
      $entity1
        ->getConfigDependencyName(),
    ));
    $this
      ->assertFalse(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 does not have a dependency on itself.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity2']), 'config_test.dynamic.entity2 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity3']), 'config_test.dynamic.entity3 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity4']), 'config_test.dynamic.entity4 has a dependency on config_test.dynamic.entity1.');

    // Test getting $entity2's dependencies as entities.
    $dependents = $config_manager
      ->findConfigEntityDependentsAsEntities('config', array(
      $entity2
        ->getConfigDependencyName(),
    ));
    $dependent_ids = $this
      ->getDependentIds($dependents);
    $this
      ->assertFalse(in_array('config_test:entity1', $dependent_ids), 'config_test.dynamic.entity1 does not have a dependency on config_test.dynamic.entity1.');
    $this
      ->assertFalse(in_array('config_test:entity2', $dependent_ids), 'config_test.dynamic.entity2 does not have a dependency on itself.');
    $this
      ->assertTrue(in_array('config_test:entity3', $dependent_ids), 'config_test.dynamic.entity3 has a dependency on config_test.dynamic.entity2.');
    $this
      ->assertTrue(in_array('config_test:entity4', $dependent_ids), 'config_test.dynamic.entity4 has a dependency on config_test.dynamic.entity2.');

    // Test getting node module's dependencies as configuration dependency
    // objects.
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'node',
    ));
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 has a dependency on the Node module.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity2']), 'config_test.dynamic.entity2 has a dependency on the Node module.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity3']), 'config_test.dynamic.entity3 has a dependency on the Node module.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity4']), 'config_test.dynamic.entity4 has a dependency on the Node module.');

    // Test getting node module's dependencies as configuration dependency
    // objects after making $entity3 also dependent on node module but $entity1
    // no longer depend on node module.
    $entity1
      ->setEnforcedDependencies([])
      ->save();
    $entity3
      ->setEnforcedDependencies([
      'module' => [
        'node',
      ],
      'config' => [
        $entity2
          ->getConfigDependencyName(),
      ],
    ])
      ->save();
    $dependents = $config_manager
      ->findConfigEntityDependents('module', array(
      'node',
    ));
    $this
      ->assertFalse(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 does not have a dependency on the Node module.');
    $this
      ->assertFalse(isset($dependents['config_test.dynamic.entity2']), 'config_test.dynamic.entity2 does not have a dependency on the Node module.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity3']), 'config_test.dynamic.entity3 has a dependency on the Node module.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity4']), 'config_test.dynamic.entity4 has a dependency on the Node module.');

    // Test dependency on a content entity.
    $entity_test = entity_create('entity_test', array(
      'name' => $this
        ->randomString(),
      'type' => 'entity_test',
    ));
    $entity_test
      ->save();
    $entity2
      ->setEnforcedDependencies([
      'config' => [
        $entity1
          ->getConfigDependencyName(),
      ],
      'content' => [
        $entity_test
          ->getConfigDependencyName(),
      ],
    ])
      ->save();
    $dependents = $config_manager
      ->findConfigEntityDependents('content', array(
      $entity_test
        ->getConfigDependencyName(),
    ));
    $this
      ->assertFalse(isset($dependents['config_test.dynamic.entity1']), 'config_test.dynamic.entity1 does not have a dependency on the content entity.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity2']), 'config_test.dynamic.entity2 has a dependency on the content entity.');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity3']), 'config_test.dynamic.entity3 has a dependency on the content entity (via entity2).');
    $this
      ->assertTrue(isset($dependents['config_test.dynamic.entity4']), 'config_test.dynamic.entity4 has a dependency on the content entity (via entity3).');

    // Create a configuration entity of a different type with the same ID as one
    // of the entities already created.
    $alt_storage = $this->container
      ->get('entity.manager')
      ->getStorage('config_query_test');
    $alt_storage
      ->create(array(
      'id' => 'entity1',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ))
      ->save();
    $alt_storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'module' => array(
            'views',
          ),
        ),
      ),
    ))
      ->save();
    $dependents = $config_manager
      ->findConfigEntityDependentsAsEntities('config', array(
      $entity1
        ->getConfigDependencyName(),
    ));
    $dependent_ids = $this
      ->getDependentIds($dependents);
    $this
      ->assertFalse(in_array('config_test:entity1', $dependent_ids), 'config_test.dynamic.entity1 does not have a dependency on itself.');
    $this
      ->assertTrue(in_array('config_test:entity2', $dependent_ids), 'config_test.dynamic.entity2 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertTrue(in_array('config_test:entity3', $dependent_ids), 'config_test.dynamic.entity3 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertTrue(in_array('config_test:entity4', $dependent_ids), 'config_test.dynamic.entity4 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertTrue(in_array('config_query_test:entity1', $dependent_ids), 'config_query_test.dynamic.entity1 has a dependency on config_test.dynamic.entity1.');
    $this
      ->assertFalse(in_array('config_query_test:entity2', $dependent_ids), 'config_query_test.dynamic.entity2 does not have a dependency on config_test.dynamic.entity1.');
    $dependents = $config_manager
      ->findConfigEntityDependentsAsEntities('module', array(
      'node',
      'views',
    ));
    $dependent_ids = $this
      ->getDependentIds($dependents);
    $this
      ->assertFalse(in_array('config_test:entity1', $dependent_ids), 'config_test.dynamic.entity1 does not have a dependency on Views or Node.');
    $this
      ->assertFalse(in_array('config_test:entity2', $dependent_ids), 'config_test.dynamic.entity2 does not have a dependency on Views or Node.');
    $this
      ->assertTrue(in_array('config_test:entity3', $dependent_ids), 'config_test.dynamic.entity3 has a dependency on Views or Node.');
    $this
      ->assertTrue(in_array('config_test:entity4', $dependent_ids), 'config_test.dynamic.entity4 has a dependency on Views or Node.');
    $this
      ->assertFalse(in_array('config_query_test:entity1', $dependent_ids), 'config_test.query.entity1 does not have a dependency on Views or Node.');
    $this
      ->assertTrue(in_array('config_query_test:entity2', $dependent_ids), 'config_test.query.entity2 has a dependency on Views or Node.');
    $dependents = $config_manager
      ->findConfigEntityDependentsAsEntities('module', array(
      'config_test',
    ));
    $dependent_ids = $this
      ->getDependentIds($dependents);
    $this
      ->assertTrue(in_array('config_test:entity1', $dependent_ids), 'config_test.dynamic.entity1 has a dependency on config_test module.');
    $this
      ->assertTrue(in_array('config_test:entity2', $dependent_ids), 'config_test.dynamic.entity2 has a dependency on config_test module.');
    $this
      ->assertTrue(in_array('config_test:entity3', $dependent_ids), 'config_test.dynamic.entity3 has a dependency on config_test module.');
    $this
      ->assertTrue(in_array('config_test:entity4', $dependent_ids), 'config_test.dynamic.entity4 has a dependency on config_test module.');
    $this
      ->assertTrue(in_array('config_query_test:entity1', $dependent_ids), 'config_test.query.entity1 has a dependency on config_test module.');
    $this
      ->assertTrue(in_array('config_query_test:entity2', $dependent_ids), 'config_test.query.entity2 has a dependency on config_test module.');

    // Test the ability to find missing content dependencies.
    $missing_dependencies = $config_manager
      ->findMissingContentDependencies();
    $this
      ->assertEqual([], $missing_dependencies);
    $expected = [
      $entity_test
        ->uuid() => [
        'entity_type' => 'entity_test',
        'bundle' => $entity_test
          ->bundle(),
        'uuid' => $entity_test
          ->uuid(),
      ],
    ];

    // Delete the content entity so that is it now missing.
    $entity_test
      ->delete();
    $missing_dependencies = $config_manager
      ->findMissingContentDependencies();
    $this
      ->assertEqual($expected, $missing_dependencies);

    // Add a fake missing dependency to ensure multiple missing dependencies
    // work.
    $entity1
      ->setEnforcedDependencies([
      'content' => [
        $entity_test
          ->getConfigDependencyName(),
        'entity_test:bundle:uuid',
      ],
    ])
      ->save();
    $expected['uuid'] = [
      'entity_type' => 'entity_test',
      'bundle' => 'bundle',
      'uuid' => 'uuid',
    ];
    $missing_dependencies = $config_manager
      ->findMissingContentDependencies();
    $this
      ->assertEqual($expected, $missing_dependencies);
  }

  /**
   * Tests ConfigManager::uninstall() and config entity dependency management.
   */
  public function testConfigEntityUninstall() {

    /** @var \Drupal\Core\Config\ConfigManagerInterface $config_manager */
    $config_manager = \Drupal::service('config.manager');

    /** @var \Drupal\Core\Config\Entity\ConfigEntityStorage $storage */
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('config_test');

    // Test dependencies between modules.
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
      'dependencies' => array(
        'enforced' => array(
          'module' => array(
            'node',
            'config_test',
          ),
        ),
      ),
    ));
    $entity1
      ->save();
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();

    // Perform a module rebuild so we can know where the node module is located
    // and uninstall it.
    // @todo Remove as part of https://www.drupal.org/node/2186491
    system_rebuild_module_data();

    // Test that doing a config uninstall of the node module deletes entity2
    // since it is dependent on entity1 which is dependent on the node module.
    $config_manager
      ->uninstall('module', 'node');
    $this
      ->assertFalse($storage
      ->load('entity1'), 'Entity 1 deleted');
    $this
      ->assertFalse($storage
      ->load('entity2'), 'Entity 2 deleted');

    // Set a more complicated test where dependencies will be fixed.
    \Drupal::state()
      ->set('config_test.fix_dependencies', array(
      $entity1
        ->getConfigDependencyName(),
    ));

    // Entity1 will be deleted because it depends on node.
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
      'dependencies' => array(
        'enforced' => array(
          'module' => array(
            'node',
            'config_test',
          ),
        ),
      ),
    ));
    $entity1
      ->save();

    // Entity2 has a dependency on Entity1 but it can be fixed because
    // \Drupal\config_test\Entity::onDependencyRemoval() will remove the
    // dependency before config entities are deleted.
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();

    // Entity3 will be unchanged because it is dependent on Entity2 which can
    // be fixed.
    $entity3 = $storage
      ->create(array(
      'id' => 'entity3',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity2
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity3
      ->save();

    // Entity4's config dependency will be fixed but it will still be deleted
    // because it also depends on the node module.
    $entity4 = $storage
      ->create(array(
      'id' => 'entity4',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
          'module' => array(
            'node',
            'config_test',
          ),
        ),
      ),
    ));
    $entity4
      ->save();

    // Do a dry run using
    // \Drupal\Core\Config\ConfigManager::getConfigEntitiesToChangeOnDependencyRemoval().
    $config_entities = $config_manager
      ->getConfigEntitiesToChangeOnDependencyRemoval('module', [
      'node',
    ]);
    $this
      ->assertEqual($entity1
      ->uuid(), $config_entities['delete'][0]
      ->uuid(), 'Entity 1 will be deleted.');
    $this
      ->assertEqual($entity2
      ->uuid(), reset($config_entities['update'])
      ->uuid(), 'Entity 2 will be updated.');
    $this
      ->assertEqual($entity3
      ->uuid(), reset($config_entities['unchanged'])
      ->uuid(), 'Entity 3 is not changed.');
    $this
      ->assertEqual($entity4
      ->uuid(), $config_entities['delete'][1]
      ->uuid(), 'Entity 4 will be deleted.');

    // Perform the uninstall.
    $config_manager
      ->uninstall('module', 'node');

    // Test that expected actions have been performed.
    $this
      ->assertFalse($storage
      ->load('entity1'), 'Entity 1 deleted');
    $entity2 = $storage
      ->load('entity2');
    $this
      ->assertTrue($entity2, 'Entity 2 not deleted');
    $this
      ->assertEqual($entity2
      ->calculateDependencies()
      ->getDependencies()['config'], array(), 'Entity 2 dependencies updated to remove dependency on Entity1.');
    $entity3 = $storage
      ->load('entity3');
    $this
      ->assertTrue($entity3, 'Entity 3 not deleted');
    $this
      ->assertEqual($entity3
      ->calculateDependencies()
      ->getDependencies()['config'], [
      $entity2
        ->getConfigDependencyName(),
    ], 'Entity 3 still depends on Entity 2.');
    $this
      ->assertFalse($storage
      ->load('entity4'), 'Entity 4 deleted');
  }

  /**
   * Tests deleting a configuration entity and dependency management.
   */
  public function testConfigEntityDelete() {

    /** @var \Drupal\Core\Config\ConfigManagerInterface $config_manager */
    $config_manager = \Drupal::service('config.manager');

    /** @var \Drupal\Core\Config\Entity\ConfigEntityStorage $storage */
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('config_test');

    // Test dependencies between configuration entities.
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
    ));
    $entity1
      ->save();
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();

    // Do a dry run using
    // \Drupal\Core\Config\ConfigManager::getConfigEntitiesToChangeOnDependencyRemoval().
    $config_entities = $config_manager
      ->getConfigEntitiesToChangeOnDependencyRemoval('config', [
      $entity1
        ->getConfigDependencyName(),
    ]);
    $this
      ->assertEqual($entity2
      ->uuid(), reset($config_entities['delete'])
      ->uuid(), 'Entity 2 will be deleted.');
    $this
      ->assertTrue(empty($config_entities['update']), 'No dependent configuration entities will be updated.');
    $this
      ->assertTrue(empty($config_entities['unchanged']), 'No dependent configuration entities will be unchanged.');

    // Test that doing a delete of entity1 deletes entity2 since it is dependent
    // on entity1.
    $entity1
      ->delete();
    $this
      ->assertFalse($storage
      ->load('entity1'), 'Entity 1 deleted');
    $this
      ->assertFalse($storage
      ->load('entity2'), 'Entity 2 deleted');

    // Set a more complicated test where dependencies will be fixed.
    \Drupal::state()
      ->set('config_test.fix_dependencies', array(
      $entity1
        ->getConfigDependencyName(),
    ));

    // Entity1 will be deleted by the test.
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
    ));
    $entity1
      ->save();

    // Entity2 has a dependency on Entity1 but it can be fixed because
    // \Drupal\config_test\Entity::onDependencyRemoval() will remove the
    // dependency before config entities are deleted.
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();

    // Entity3 will be unchanged because it is dependent on Entity2 which can
    // be fixed.
    $entity3 = $storage
      ->create(array(
      'id' => 'entity3',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity2
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity3
      ->save();

    // Do a dry run using
    // \Drupal\Core\Config\ConfigManager::getConfigEntitiesToChangeOnDependencyRemoval().
    $config_entities = $config_manager
      ->getConfigEntitiesToChangeOnDependencyRemoval('config', [
      $entity1
        ->getConfigDependencyName(),
    ]);
    $this
      ->assertTrue(empty($config_entities['delete']), 'No dependent configuration entities will be deleted.');
    $this
      ->assertEqual($entity2
      ->uuid(), reset($config_entities['update'])
      ->uuid(), 'Entity 2 will be updated.');
    $this
      ->assertEqual($entity3
      ->uuid(), reset($config_entities['unchanged'])
      ->uuid(), 'Entity 3 is not changed.');

    // Perform the uninstall.
    $entity1
      ->delete();

    // Test that expected actions have been performed.
    $this
      ->assertFalse($storage
      ->load('entity1'), 'Entity 1 deleted');
    $entity2 = $storage
      ->load('entity2');
    $this
      ->assertTrue($entity2, 'Entity 2 not deleted');
    $this
      ->assertEqual($entity2
      ->calculateDependencies()
      ->getDependencies()['config'], array(), 'Entity 2 dependencies updated to remove dependency on Entity1.');
    $entity3 = $storage
      ->load('entity3');
    $this
      ->assertTrue($entity3, 'Entity 3 not deleted');
    $this
      ->assertEqual($entity3
      ->calculateDependencies()
      ->getDependencies()['config'], [
      $entity2
        ->getConfigDependencyName(),
    ], 'Entity 3 still depends on Entity 2.');
  }

  /**
   * Tests getConfigEntitiesToChangeOnDependencyRemoval() with content entities.
   *
   * At the moment there is no runtime code that calculates configuration
   * dependencies on content entity delete because this calculation is expensive
   * and all content dependencies are soft. This test ensures that the code
   * works for content entities.
   *
   * @see \Drupal\Core\Config\ConfigManager::getConfigEntitiesToChangeOnDependencyRemoval()
   */
  public function testContentEntityDelete() {
    $this
      ->installEntitySchema('entity_test');

    /** @var \Drupal\Core\Config\ConfigManagerInterface $config_manager */
    $config_manager = \Drupal::service('config.manager');
    $content_entity = EntityTest::create();
    $content_entity
      ->save();

    /** @var \Drupal\Core\Config\Entity\ConfigEntityStorage $storage */
    $storage = $this->container
      ->get('entity.manager')
      ->getStorage('config_test');
    $entity1 = $storage
      ->create(array(
      'id' => 'entity1',
      'dependencies' => array(
        'enforced' => array(
          'content' => array(
            $content_entity
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity1
      ->save();
    $entity2 = $storage
      ->create(array(
      'id' => 'entity2',
      'dependencies' => array(
        'enforced' => array(
          'config' => array(
            $entity1
              ->getConfigDependencyName(),
          ),
        ),
      ),
    ));
    $entity2
      ->save();

    // Create a configuration entity that is not in the dependency chain.
    $entity3 = $storage
      ->create(array(
      'id' => 'entity3',
    ));
    $entity3
      ->save();
    $config_entities = $config_manager
      ->getConfigEntitiesToChangeOnDependencyRemoval('content', [
      $content_entity
        ->getConfigDependencyName(),
    ]);
    $this
      ->assertEqual($entity1
      ->uuid(), $config_entities['delete'][0]
      ->uuid(), 'Entity 1 will be deleted.');
    $this
      ->assertEqual($entity2
      ->uuid(), $config_entities['delete'][1]
      ->uuid(), 'Entity 2 will be deleted.');
    $this
      ->assertTrue(empty($config_entities['update']), 'No dependencies of the content entity will be updated.');
    $this
      ->assertTrue(empty($config_entities['unchanged']), 'No dependencies of the content entity will be unchanged.');
  }

  /**
   * Gets a list of identifiers from an array of configuration entities.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityInterface[] $dependents
   *   An array of configuration entities.
   *
   * @return array
   *   An array with values of entity_type_id:ID
   */
  protected function getDependentIds(array $dependents) {
    $dependent_ids = array();
    foreach ($dependents as $dependent) {
      $dependent_ids[] = $dependent
        ->getEntityTypeId() . ':' . $dependent
        ->id();
    }
    return $dependent_ids;
  }

}

Members

Namesort descending Modifiers Type Description 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. 2
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 the raw text IS NOT found escaped on the 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::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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
ConfigDependencyTest::$modules public static property Modules to enable. Overrides EntityUnitTestBase::$modules
ConfigDependencyTest::getDependentIds protected function Gets a list of identifiers from an array of configuration entities.
ConfigDependencyTest::testConfigEntityDelete public function Tests deleting a configuration entity and dependency management.
ConfigDependencyTest::testConfigEntityUninstall public function Tests ConfigManager::uninstall() and config entity dependency management.
ConfigDependencyTest::testContentEntityDelete public function Tests getConfigEntitiesToChangeOnDependencyRemoval() with content entities.
ConfigDependencyTest::testDependencyManagement public function Tests creating dependencies on configuration entities.
ConfigDependencyTest::testNonEntity public function Tests that calculating dependencies for system module.
EntityUnitTestBase::$entityManager protected property The entity manager service.
EntityUnitTestBase::$generatedIds protected property A list of generated identifiers.
EntityUnitTestBase::$state protected property The state service.
EntityUnitTestBase::createUser protected function Creates a user.
EntityUnitTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityUnitTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityUnitTestBase::installModule protected function Installs a module and refreshes services.
EntityUnitTestBase::refreshServices protected function Refresh services. 1
EntityUnitTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityUnitTestBase::setUp protected function Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp 44
EntityUnitTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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 public function Callback for random string validation.
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.