View source
<?php
namespace Drupal\Tests\Core\Config\Entity;
use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Core\Config\Schema\SchemaIncompleteException;
use Drupal\Core\DependencyInjection\ContainerBuilder;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Extension\ThemeHandlerInterface;
use Drupal\Core\Language\Language;
use Drupal\Core\Plugin\DefaultLazyPluginCollection;
use Drupal\Tests\Core\Config\Entity\Fixtures\ConfigEntityBaseWithPluginCollections;
use Drupal\Tests\Core\Plugin\Fixtures\TestConfigurablePlugin;
use Drupal\Tests\UnitTestCase;
class ConfigEntityBaseUnitTest extends UnitTestCase {
protected $entity;
protected $entityType;
protected $entityTypeManager;
protected $entityTypeId;
protected $uuid;
protected $provider = 'the_provider_of_the_entity_type';
protected $languageManager;
protected $id;
protected $cacheTagsInvalidator;
protected $typedConfigManager;
protected $moduleHandler;
protected $themeHandler;
protected function setUp() {
$this->id = $this
->randomMachineName();
$values = [
'id' => $this->id,
'langcode' => 'en',
'uuid' => '3bb9ee60-bea5-4622-b89b-a63319d10b3a',
];
$this->entityTypeId = $this
->randomMachineName();
$this->entityType = $this
->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityTypeInterface');
$this->entityType
->expects($this
->any())
->method('getProvider')
->will($this
->returnValue($this->provider));
$this->entityType
->expects($this
->any())
->method('getConfigPrefix')
->willReturn('test_provider.' . $this->entityTypeId);
$this->entityTypeManager = $this
->createMock(EntityTypeManagerInterface::class);
$this->entityTypeManager
->expects($this
->any())
->method('getDefinition')
->with($this->entityTypeId)
->will($this
->returnValue($this->entityType));
$this->uuid = $this
->createMock('\\Drupal\\Component\\Uuid\\UuidInterface');
$this->languageManager = $this
->createMock('\\Drupal\\Core\\Language\\LanguageManagerInterface');
$this->languageManager
->expects($this
->any())
->method('getLanguage')
->with('en')
->will($this
->returnValue(new Language([
'id' => 'en',
])));
$this->cacheTagsInvalidator = $this
->createMock('Drupal\\Core\\Cache\\CacheTagsInvalidatorInterface');
$this->typedConfigManager = $this
->createMock('Drupal\\Core\\Config\\TypedConfigManagerInterface');
$this->moduleHandler = $this
->prophesize(ModuleHandlerInterface::class);
$this->themeHandler = $this
->prophesize(ThemeHandlerInterface::class);
$container = new ContainerBuilder();
$container
->set('entity_type.manager', $this->entityTypeManager);
$container
->set('uuid', $this->uuid);
$container
->set('language_manager', $this->languageManager);
$container
->set('cache_tags.invalidator', $this->cacheTagsInvalidator);
$container
->set('config.typed', $this->typedConfigManager);
$container
->set('module_handler', $this->moduleHandler
->reveal());
$container
->set('theme_handler', $this->themeHandler
->reveal());
\Drupal::setContainer($container);
$this->entity = $this
->getMockForAbstractClass('\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase', [
$values,
$this->entityTypeId,
]);
}
public function testCalculateDependencies() {
$this->entity
->set('dependencies', [
'module' => [
'node',
],
]);
$this
->assertEmpty($this->entity
->calculateDependencies()
->getDependencies());
$this->entity
->set('dependencies', [
'module' => [
'node',
],
'enforced' => [
'module' => 'views',
],
]);
$dependencies = $this->entity
->calculateDependencies()
->getDependencies();
$this
->assertStringContainsString('views', $dependencies['module']);
$this
->assertStringNotContainsString('node', $dependencies['module']);
}
public function testPreSaveDuringSync() {
$this->moduleHandler
->moduleExists('node')
->willReturn(TRUE);
$query = $this
->createMock('\\Drupal\\Core\\Entity\\Query\\QueryInterface');
$storage = $this
->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityStorageInterface');
$query
->expects($this
->any())
->method('execute')
->will($this
->returnValue([]));
$query
->expects($this
->any())
->method('condition')
->will($this
->returnValue($query));
$storage
->expects($this
->any())
->method('getQuery')
->will($this
->returnValue($query));
$storage
->expects($this
->any())
->method('loadUnchanged')
->will($this
->returnValue($this->entity));
$this->entity
->set('dependencies', [
'module' => [
'node',
],
]);
$this->entity
->preSave($storage);
$this
->assertEmpty($this->entity
->getDependencies());
$this->entity
->setSyncing(TRUE);
$this->entity
->set('dependencies', [
'module' => [
'node',
],
]);
$this->entity
->preSave($storage);
$dependencies = $this->entity
->getDependencies();
$this
->assertContains('node', $dependencies['module']);
}
public function testAddDependency() {
$method = new \ReflectionMethod('\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase', 'addDependency');
$method
->setAccessible(TRUE);
$method
->invoke($this->entity, 'module', $this->provider);
$method
->invoke($this->entity, 'module', 'core');
$method
->invoke($this->entity, 'module', 'node');
$dependencies = $this->entity
->getDependencies();
$this
->assertNotContains($this->provider, $dependencies['module']);
$this
->assertNotContains('core', $dependencies['module']);
$this
->assertContains('node', $dependencies['module']);
$method
->invoke($this->entity, 'module', 'action');
$dependencies = $this->entity
->getDependencies();
$this
->assertEquals([
'action',
'node',
], $dependencies['module']);
$method
->invoke($this->entity, 'entity', 'system.action.id');
$dependencies = $this->entity
->getDependencies();
$this
->assertEquals([
'entity',
'module',
], array_keys($dependencies));
}
public function testCalculateDependenciesWithPluginCollections($definition, $expected_dependencies) {
$this->moduleHandler
->moduleExists('the_provider_of_the_entity_type')
->willReturn(TRUE);
$this->moduleHandler
->moduleExists('test')
->willReturn(TRUE);
$this->moduleHandler
->moduleExists('test_theme')
->willReturn(FALSE);
$this->themeHandler
->themeExists('test_theme')
->willReturn(TRUE);
$values = [];
$this->entity = $this
->getMockBuilder('\\Drupal\\Tests\\Core\\Config\\Entity\\Fixtures\\ConfigEntityBaseWithPluginCollections')
->setConstructorArgs([
$values,
$this->entityTypeId,
])
->setMethods([
'getPluginCollections',
])
->getMock();
$instance_id = $this
->randomMachineName();
$instance = new TestConfigurablePlugin([], $instance_id, $definition);
$pluginCollection = $this
->getMockBuilder('\\Drupal\\Core\\Plugin\\DefaultLazyPluginCollection')
->disableOriginalConstructor()
->setMethods([
'get',
])
->getMock();
$pluginCollection
->expects($this
->atLeastOnce())
->method('get')
->with($instance_id)
->will($this
->returnValue($instance));
$pluginCollection
->addInstanceId($instance_id);
$this->entity
->expects($this
->once())
->method('getPluginCollections')
->will($this
->returnValue([
$pluginCollection,
]));
$this
->assertEquals($expected_dependencies, $this->entity
->calculateDependencies()
->getDependencies());
}
public function providerCalculateDependenciesWithPluginCollections() {
$instance_dependency_1 = 'a' . $this
->randomMachineName(10);
$instance_dependency_2 = 'a' . $this
->randomMachineName(11);
return [
[
[
'provider' => 'test',
],
[
'module' => [
'test',
],
],
],
[
[
'provider' => 'test_theme',
],
[
'theme' => [
'test_theme',
],
],
],
[
[
'provider' => $this->provider,
],
[],
],
[
[
'provider' => 'test',
'config_dependencies' => [
'config' => [
$instance_dependency_1,
],
'module' => [
$instance_dependency_2,
],
],
],
[
'config' => [
$instance_dependency_1,
],
'module' => [
$instance_dependency_2,
'test',
],
],
],
];
}
public function testCalculateDependenciesWithThirdPartySettings() {
$this->entity = $this
->getMockForAbstractClass('\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase', [
[],
$this->entityTypeId,
]);
$this->entity
->setThirdPartySetting('test_provider', 'test', 'test');
$this->entity
->setThirdPartySetting('test_provider2', 'test', 'test');
$this->entity
->setThirdPartySetting($this->provider, 'test', 'test');
$this
->assertEquals([
'test_provider',
'test_provider2',
], $this->entity
->calculateDependencies()
->getDependencies()['module']);
$changed = $this->entity
->onDependencyRemoval([
'module' => [
'test_provider2',
],
]);
$this
->assertTrue($changed, 'Calling onDependencyRemoval with an existing third party dependency provider returns TRUE.');
$changed = $this->entity
->onDependencyRemoval([
'module' => [
'test_provider3',
],
]);
$this
->assertFalse($changed, 'Calling onDependencyRemoval with a non-existing third party dependency provider returns FALSE.');
$this
->assertEquals([
'test_provider',
], $this->entity
->calculateDependencies()
->getDependencies()['module']);
}
public function testSleepWithPluginCollections() {
$instance_id = 'the_instance_id';
$instance = new TestConfigurablePlugin([], $instance_id, []);
$plugin_manager = $this
->prophesize(PluginManagerInterface::class);
$plugin_manager
->createInstance($instance_id, [
'id' => $instance_id,
])
->willReturn($instance);
$container = new ContainerBuilder();
$container
->set('plugin.manager.foo', $plugin_manager);
\Drupal::setContainer($container);
$entity_values = [
'the_plugin_collection_config' => [
$instance_id => [
'foo' => 'original_value',
],
],
];
$entity = new TestConfigEntityWithPluginCollections($entity_values, $this->entityTypeId);
$entity
->setPluginManager($plugin_manager
->reveal());
$instance
->setConfiguration([
'foo' => 'new_value',
]);
$expected_plugin_config = [
$instance_id => [
'foo' => 'original_value',
],
];
$this
->assertSame($expected_plugin_config, $entity
->get('the_plugin_collection_config'));
$vars = $entity
->__sleep();
$this
->assertNotContains('pluginCollection', $vars);
$this
->assertNotContains('pluginManager', $vars);
$this
->assertSame([
'pluginManager' => 'plugin.manager.foo',
], $entity
->get('_serviceIds'));
$expected_plugin_config = [
$instance_id => [
'foo' => 'new_value',
],
];
$this
->assertSame($expected_plugin_config, $entity
->get('the_plugin_collection_config'));
}
public function testGetOriginalId() {
$new_id = $this
->randomMachineName();
$this->entity
->set('id', $new_id);
$this
->assertSame($this->id, $this->entity
->getOriginalId());
$this
->assertSame($this->entity, $this->entity
->setOriginalId($new_id));
$this
->assertSame($new_id, $this->entity
->getOriginalId());
$this
->assertFalse($this->entity
->isNew());
$this->entity
->setOriginalId($this
->randomMachineName());
$this
->assertFalse($this->entity
->isNew());
$this->entity
->enforceIsNew();
$this
->assertTrue($this->entity
->isNew());
$this->entity
->setOriginalId($this
->randomMachineName());
$this
->assertTrue($this->entity
->isNew());
}
public function testIsNew() {
$this
->assertFalse($this->entity
->isNew());
$this
->assertSame($this->entity, $this->entity
->enforceIsNew());
$this
->assertTrue($this->entity
->isNew());
$this->entity
->enforceIsNew(FALSE);
$this
->assertFalse($this->entity
->isNew());
}
public function testGet() {
$name = 'id';
$value = $this
->randomMachineName();
$this
->assertSame($this->id, $this->entity
->get($name));
$this
->assertSame($this->entity, $this->entity
->set($name, $value));
$this
->assertSame($value, $this->entity
->get($name));
}
public function testSetStatus() {
$this
->assertTrue($this->entity
->status());
$this
->assertSame($this->entity, $this->entity
->setStatus(FALSE));
$this
->assertFalse($this->entity
->status());
$this->entity
->setStatus(TRUE);
$this
->assertTrue($this->entity
->status());
}
public function testEnable() {
$this->entity
->setStatus(FALSE);
$this
->assertSame($this->entity, $this->entity
->enable());
$this
->assertTrue($this->entity
->status());
}
public function testDisable() {
$this->entity
->setStatus(TRUE);
$this
->assertSame($this->entity, $this->entity
->disable());
$this
->assertFalse($this->entity
->status());
}
public function testIsSyncing() {
$this
->assertFalse($this->entity
->isSyncing());
$this
->assertSame($this->entity, $this->entity
->setSyncing(TRUE));
$this
->assertTrue($this->entity
->isSyncing());
$this->entity
->setSyncing(FALSE);
$this
->assertFalse($this->entity
->isSyncing());
}
public function testCreateDuplicate() {
$this->entityType
->expects($this
->at(0))
->method('getKey')
->with('id')
->will($this
->returnValue('id'));
$this->entityType
->expects($this
->at(1))
->method('hasKey')
->with('uuid')
->will($this
->returnValue(TRUE));
$this->entityType
->expects($this
->at(2))
->method('getKey')
->with('uuid')
->will($this
->returnValue('uuid'));
$new_uuid = '8607ef21-42bc-4913-978f-8c06207b0395';
$this->uuid
->expects($this
->once())
->method('generate')
->will($this
->returnValue($new_uuid));
$duplicate = $this->entity
->createDuplicate();
$this
->assertInstanceOf('\\Drupal\\Core\\Entity\\EntityBase', $duplicate);
$this
->assertNotSame($this->entity, $duplicate);
$this
->assertFalse($this->entity
->isNew());
$this
->assertTrue($duplicate
->isNew());
$this
->assertNull($duplicate
->id());
$this
->assertNull($duplicate
->getOriginalId());
$this
->assertNotEquals($this->entity
->uuid(), $duplicate
->uuid());
$this
->assertSame($new_uuid, $duplicate
->uuid());
}
public function testSort() {
$this->entityTypeManager
->expects($this
->any())
->method('getDefinition')
->with($this->entityTypeId)
->will($this
->returnValue([
'entity_keys' => [
'label' => 'label',
],
]));
$entity_a = $this
->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityInterface');
$entity_a
->expects($this
->atLeastOnce())
->method('label')
->willReturn('foo');
$entity_b = $this
->createMock('\\Drupal\\Core\\Config\\Entity\\ConfigEntityInterface');
$entity_b
->expects($this
->atLeastOnce())
->method('label')
->willReturn('bar');
$list = [
$entity_a,
$entity_b,
];
@usort($list, '\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase::sort');
$this
->assertSame($entity_b, $list[0]);
$list = [
$entity_b,
$entity_a,
];
@usort($list, '\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase::sort');
$this
->assertSame($entity_b, $list[0]);
$entity_a->weight = 0;
$entity_b->weight = 1;
$list = [
$entity_b,
$entity_a,
];
@usort($list, '\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase::sort');
$this
->assertSame($entity_a, $list[0]);
$list = [
$entity_a,
$entity_b,
];
@usort($list, '\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase::sort');
$this
->assertSame($entity_a, $list[0]);
}
public function testToArray() {
$this->typedConfigManager
->expects($this
->never())
->method('getDefinition');
$this->entityType
->expects($this
->any())
->method('getPropertiesToExport')
->willReturn([
'id' => 'configId',
'dependencies' => 'dependencies',
]);
$properties = $this->entity
->toArray();
$this
->assertIsArray($properties);
$this
->assertEquals([
'configId' => $this->entity
->id(),
'dependencies' => [],
], $properties);
}
public function testToArrayIdKey() {
$entity = $this
->getMockForAbstractClass('\\Drupal\\Core\\Config\\Entity\\ConfigEntityBase', [
[],
$this->entityTypeId,
], '', TRUE, TRUE, TRUE, [
'id',
'get',
]);
$entity
->expects($this
->atLeastOnce())
->method('id')
->willReturn($this->id);
$entity
->expects($this
->once())
->method('get')
->with('dependencies')
->willReturn([]);
$this->typedConfigManager
->expects($this
->never())
->method('getDefinition');
$this->entityType
->expects($this
->any())
->method('getPropertiesToExport')
->willReturn([
'id' => 'configId',
'dependencies' => 'dependencies',
]);
$this->entityType
->expects($this
->once())
->method('getKey')
->with('id')
->willReturn('id');
$properties = $entity
->toArray();
$this
->assertIsArray($properties);
$this
->assertEquals([
'configId' => $entity
->id(),
'dependencies' => [],
], $properties);
}
public function testThirdPartySettings() {
$key = 'test';
$third_party = 'test_provider';
$value = $this
->getRandomGenerator()
->string();
$this
->assertEquals($value, $this->entity
->getThirdPartySetting($third_party, $key, $value));
$this
->assertNull($this->entity
->getThirdPartySetting($third_party, $key));
$this->entity
->setThirdPartySetting($third_party, $key, $value);
$this
->assertEquals($value, $this->entity
->getThirdPartySetting($third_party, $key));
$this
->assertEquals($value, $this->entity
->getThirdPartySetting($third_party, $key, $this->randomGenerator
->string()));
$this->entity
->setThirdPartySetting($third_party, 'test2', 'value2');
$this
->assertEquals([
$key => $value,
'test2' => 'value2',
], $this->entity
->getThirdPartySettings($third_party));
$this->entity
->setThirdPartySetting('test_provider2', $key, $value);
$this
->assertEquals([
$third_party,
'test_provider2',
], $this->entity
->getThirdPartyProviders());
$this->entity
->unsetThirdPartySetting('test_provider2', $key);
$this
->assertEquals([
$third_party,
], $this->entity
->getThirdPartyProviders());
}
public function testToArraySchemaException() {
$this->entityType
->expects($this
->any())
->method('getPropertiesToExport')
->willReturn(NULL);
$this
->expectException(SchemaIncompleteException::class);
$this
->expectExceptionMessageRegExp("/Entity type 'Mock_ConfigEntityTypeInterface_[^']*' is missing 'config_export' definition in its annotation/");
$this->entity
->toArray();
}
}
class TestConfigEntityWithPluginCollections extends ConfigEntityBaseWithPluginCollections {
protected $pluginCollection;
protected $pluginManager;
public function setPluginManager(PluginManagerInterface $plugin_manager) {
$this->pluginManager = $plugin_manager;
}
public function getPluginCollections() {
if (!$this->pluginCollection) {
$this->pluginCollection = new DefaultLazyPluginCollection($this->pluginManager, [
'the_instance_id' => [
'id' => 'the_instance_id',
],
]);
}
return [
'the_plugin_collection_config' => $this->pluginCollection,
];
}
}